Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": "implementation class of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider/10000

The GET request would return the following JSON credential store provider object

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": "implementation class of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name"
}

GET (Using Query Parameters)

This GET service will return a list of credential store providers in the form of JSON objects based on the query parameters id, name, implementation class, is active, and is custom. Credential store providers are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of credential store providers.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

credentialStoreProviderId={id}

credentialStoreProviderName={name}

implementationClass={implementationClass} 

isActive={boolean}

isCustom={boolean}

Examples:
To search by name only:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?credentialStoreProviderName=ProviderName

To search by NAME IS ACTIVE:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?credentialStoreProviderName=ProviderName&isActive=true

Request

...

Response Codes

...

Example

...

,
	"updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider/10000

The GET request would return the following JSON credential store provider object

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": "implementation class of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name",
	"updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

GET (Using Query Parameters)

This GET service will return a list of credential store providers in the form of JSON objects based on the query parameters id, name, implementation class, is active, and is custom. Credential store providers are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of credential store providers.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?

Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters: 

credentialStoreProviderId={id}

credentialStoreProviderName={name}

implementationClass={implementationClass} 

isActive={boolean}

isCustom={boolean}

Examples:
To search by name only:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?credentialStoreProviderName=ProviderName

To search by NAME IS ACTIVE:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?credentialStoreProviderName=ProviderName&isActive=true

Request

AttributesTypeRequiredDescription
credentialStoreProviderIdQuery - LongNoEquals search
credentialStoreProviderNameQuery - StringNoContains ignore case search
implementationClassQuery - StringNoContains ignore case search
isActiveQuery - BooleanNoEquals search
isCustomQuery - BooleanNoEquals search

Include Page
REST V2 Credential Store Provider Response
REST V2 Credential Store Provider Response

Response Codes

HTTP CodeDescription
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If we had a credential store provider in our database with an Id of 10000 and had the following attributes

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": "implementation class of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name",
	"updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?credentialStoreProviderName=credential&isActive=true

The GET request would return the  following JSON environment object

Code Block
themeEclipse
titleCredential Store Provider - 10000
[
{
	"description": "description of credential store provider",
	"implementationClass": "implementation class of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefIdcredentialStorePropDefs": 10000[],
	"credentialStoreDefNamecredentialStoreApiTextValue": "credential store provider name"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider?credentialStoreProviderName=credential&isActive=true

The GET request would return the  following JSON environment object

Code Block
themeEclipse
titleCredential Store Provider - 10000
[
{
	"description": "description of null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name",
	"implementationClassupdatedBy": "implementationfdadmin",
class of credential store provider"createdOn",: 	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name"2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}
]

POST

This POST service will create a new credential store provider with the same attributes as the given JSON object.

...

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": null,
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "inputName": "EXAMPLE_NAME_INPUT",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11000,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStorePropDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "propertyName": "EXAMPLE_NAME_PROPERTY",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "maxValueisRequired": nulltrue,
        "isEncryptedsortNumber": falsenull,
        "minValuedisplayRows": null,
        "isActiveisMultiselect": true,
        "isRequiredpropertyDatatype": true"String",
        "sortNumbercredentialStorePropDefId": null11001,
        "displayRowsdisplayColumns": null,
        "isMultiselectlistData": truenull,
        "propertyDatatypecredentialStoreDefId": 10000
	}],
	"credentialStoreApiTextValue": "String//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name",
 	"credentialStorePropDefIdupdatedBy": 11001,
   "fdadmin",
    "displayColumnscreatedOn": null"2021-09-01T17:23:18.288+0000",
        "listDataupdatedOn": null"2021-09-01T17:23:18.288+0000",
        "credentialStoreDefIdversionNumber": 10000
	}]1,
	"credentialStoreApiTextValue": "//Groovy API Text", 	"credentialStoreDefId": 10000, 	"credentialStoreDefNamecreatedBy": "credential store provider namefdadmin"
}

Example without Child Rows

...

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
{
	"description": "description of credential store provider",
	"implementationClass": null,
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"descriptioncredentialStoreDefName": "description of credential store provider name",
	"implementationClassupdatedBy": null"fdadmin",
 	   "isActivecreatedOn": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name"2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

PUT

This PUT service will update all attributes of a credential store provider with the given Id based on the attributes of a JSON object parameters. Attributes that are not provided will become their default values.

...

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": null,
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "inputName": "EXAMPLE_NAME_INPUT",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11000,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStorePropDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "propertyName": "EXAMPLE_NAME_PROPERTY",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "propertyDatatype": "String",
        "credentialStorePropDefId": 11001,
        "displayColumns": null  "credentialStorePropDefId": 11001,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStoreApiTextValue": "null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name",
	"updatedBy": "fdadmin",
        "listDatacreatedOn": null"2021-09-01T17:23:18.288+0000",
        "credentialStoreDefIdupdatedOn": 10000
	}], 	"credentialStoreApiTextValue": "null,
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name"2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a PUT request at the following URL

...

Code Block
themeEclipse
titleCredentialStoreProvider - 10000
{
	"description": null,
	"implementationClass": null,
	"isActive": true,
 	"isCustom": false,
	"credentialStoreInputDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": "description of credential store input definition",
        "inputName": "NAME_CHANGED",
        "maxValue": nullnull,
        "isEncrypted": false,
        "minValue": null,
        "isActive": false,
        "isRequired": false,
        "isEncryptedsortNumber": falsenull,
        "minValuedisplayRows": null,
        "isActiveisMultiselect": false,
        "isRequiredinputDatatype": false"Boolean",
        "sortNumbercredentialStoreInputDefId": null11000,
        "displayRowsdisplayColumns": null,
        "isMultiselectlistData": falsenull,
        "inputDatatypecredentialStoreDefId": "Boolean",
        "credentialStoreInputDefId": 11000,
   10000
	}],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name updated",
    "displayColumnsupdatedBy": null,
   "fdadmin",
    "listDatacreatedOn": null"2021-09-01T17:23:18.288+0000",
        "credentialStoreDefIdupdatedOn": 10000
	}],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name updated"2021-09-10T06:32:19.147+0000",
    "versionNumber": 2,
    "createdBy": "fdadmin"
}

PATCH

This PATCH service will update an existing credential store provider with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the credential store provider. Child rows that are included in a PATCH will be added, but existing rows will still remain.

...

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store provider",
	"implementationClass": null,
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "inputName": "EXAMPLE_NAME_INPUT",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11000,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStorePropDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "propertyName": "EXAMPLE_NAME_PROPERTY",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "propertyDatatype": "String",
        "credentialStorePropDefId": 11001,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name",
	"displayColumnsupdatedBy": null,
  "fdadmin",
     "listDatacreatedOn": null,
   "2021-09-01T17:23:18.288+0000",
    "credentialStoreDefIdupdatedOn": 10000
	}],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name"2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a PATCH request at the following URL

...

Code Block
themeEclipse
titleUser - 10000
{
	"description": "description of credential store provider",
	"implementationClass": null,
	"isActive": true,
 	"isCustom": false,
	"credentialStoreInputDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "inputName": "EXAMPLE_NAME_INPUT",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11000,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	},
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": new credential store input definition,
        "inputName": "NEW_INPUT",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11002,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStorePropDefs": [
	{
		"length": null,
        "defaultValue": null,
        "displayName": null,
        "description": null,
        "propertyName": "EXAMPLE_NAME_PROPERTY",
        "maxValue": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": true,
        "isRequired": true,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": true,
        "propertyDatatype": "String",
        "credentialStorePropDefId": 11001,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name updated",
    "listDataupdatedBy": null"fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "credentialStoreDefIdupdatedOn": 10000
	}],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name updated"2021-09-10T06:32:19.147+0000",
    "versionNumber": 2,
    "createdBy": "fdadmin"
}