Credential Store Provider API v2

Credential store providers can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of credential store providers.

Authentication - Use Basic Authentication for this API.

GET

There are two implementations of GET. One will find a credential store provider with the given Id and return the JSON representation of the credential store provider. The other will find a list of credential store providers matching the parameters supplied to it.

GET by ID

This GET service will find a credential store provider with the given Id and return the JSON representation of the object. 

Request

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return a credential store provider

Response

AttributesTypeDescription
credentialStoreDefIdLongThe id of the credential store provider
credentialStoreDefNameStringThe name of the credential store provider
descriptionStringThe description of the credential store provider
implementationClassStringThe implementation class of the credential store provider
isActiveBooleanWeather or not the credential store provider is active
isCustomBooleanWeather or not the credential store provider is custom
credentialStoreApiTextValueStringGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>The list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>The list of credential store property definitions associated with the credential store provider

Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.

AttributesTypeDescription
credentialStoreInputDefIdLongThis is the unique Id of the credential store input definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
inputNameStringThe name of the credential store input definition
displayNameStringThe display name of the credential store input definition
descriptionStringThe description of the credential store input definition
inputDatatypeStringthe datatype associated with the credential store input definition
isRequiredBooleanWeather or not the credential store input definition is required
isEncryptedBooleanWeather or not the credential store input definition is encrypted
isActiveBooleanWeather or not the credential store input definition is active
minValueLongThe minimum value of the credential store input definition
maxValueLongThe maximum value of the credential store input definition
listDataStringThe list data associated with the credential store input definition
isMultiselectBooleanWeather or not the credential store input definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store input definition
displayColumnsIntegerThe number of display columns associated with the credential store input definition
defaultValueStringThe default value of the credential store input definition
lengthLongThe length of the credential store input definition
sortNumberIntegerThis is a number associated with the credential store input definition that sets their priority in a list of other credential store input definitions

Each credentialStorePropDef in the list of credentialStorePropDefs contains these attributes.

AttributesTypeDescription
credentialStorePropDefIdLongThis is the unique Id of the credential store property definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
propertyNameStringThe name of the credential store property definition
displayNameStringThe display name of the credential store property definition
descriptionStringThe description of the credential store property definition
propertyDatatypeStringthe datatype associated with the credential store property definition
isRequiredBooleanWeather or not the credential store property definition is required
isEncryptedBooleanWeather or not the credential store property definition is encrypted
isActiveBooleanWeather or not the credential store property definition is active
minValueLongThe minimum value of the credential store property definition
maxValueLongThe maximum value of the credential store property definition
listDataStringThe list data associated with the credential property input definition
isMultiselectBooleanWeather or not the credential store property definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store property definition
displayColumnsIntegerThe number of display columns associated with the credential store property definition
defaultValueStringThe default value of the credential store property definition
lengthLongThe length of the credential store property definition
sortNumberIntegerThis is a number associated with the credential store property definition that sets their priority in a list of other credential store property definitions

Response Codes

HTTP CodeDescription
200Credential store provider was found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Credential store provider not found
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

Credential 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/10000

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

Credential 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.

API 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

Response

AttributesTypeDescription
credentialStoreDefIdLongThe id of the credential store provider
credentialStoreDefNameStringThe name of the credential store provider
descriptionStringThe description of the credential store provider
implementationClassStringThe implementation class of the credential store provider
isActiveBooleanWeather or not the credential store provider is active
isCustomBooleanWeather or not the credential store provider is custom
credentialStoreApiTextValueStringGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>The list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>The list of credential store property definitions associated with the credential store provider

Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.

AttributesTypeDescription
credentialStoreInputDefIdLongThis is the unique Id of the credential store input definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
inputNameStringThe name of the credential store input definition
displayNameStringThe display name of the credential store input definition
descriptionStringThe description of the credential store input definition
inputDatatypeStringthe datatype associated with the credential store input definition
isRequiredBooleanWeather or not the credential store input definition is required
isEncryptedBooleanWeather or not the credential store input definition is encrypted
isActiveBooleanWeather or not the credential store input definition is active
minValueLongThe minimum value of the credential store input definition
maxValueLongThe maximum value of the credential store input definition
listDataStringThe list data associated with the credential store input definition
isMultiselectBooleanWeather or not the credential store input definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store input definition
displayColumnsIntegerThe number of display columns associated with the credential store input definition
defaultValueStringThe default value of the credential store input definition
lengthLongThe length of the credential store input definition
sortNumberIntegerThis is a number associated with the credential store input definition that sets their priority in a list of other credential store input definitions

Each credentialStorePropDef in the list of credentialStorePropDefs contains these attributes.

AttributesTypeDescription
credentialStorePropDefIdLongThis is the unique Id of the credential store property definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
propertyNameStringThe name of the credential store property definition
displayNameStringThe display name of the credential store property definition
descriptionStringThe description of the credential store property definition
propertyDatatypeStringthe datatype associated with the credential store property definition
isRequiredBooleanWeather or not the credential store property definition is required
isEncryptedBooleanWeather or not the credential store property definition is encrypted
isActiveBooleanWeather or not the credential store property definition is active
minValueLongThe minimum value of the credential store property definition
maxValueLongThe maximum value of the credential store property definition
listDataStringThe list data associated with the credential property input definition
isMultiselectBooleanWeather or not the credential store property definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store property definition
displayColumnsIntegerThe number of display columns associated with the credential store property definition
defaultValueStringThe default value of the credential store property definition
lengthLongThe length of the credential store property definition
sortNumberIntegerThis is a number associated with the credential store property definition that sets their priority in a list of other credential store property definitions

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

Credential 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

Credential 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"
}
]

POST

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

Request

AttributesTypeRequiredDescription
credentialStoreDefNameStringYesThe name of the credential store provider
descriptionStringNoThe description of the credential store provider
implementationClassStringNoThe implementation class of the credential store provider
isActiveBooleanYesWeather or not the credential store provider is active
isCustomBooleanYesWeather or not the credential store provider is custom
credentialStoreApiTextValueStringNoGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>NoThe list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>NoThe list of credential store property definitions associated with the credential store provider

Response

AttributesTypeDescription
credentialStoreDefIdLongThe id of the credential store provider
credentialStoreDefNameStringThe name of the credential store provider
descriptionStringThe description of the credential store provider
implementationClassStringThe implementation class of the credential store provider
isActiveBooleanWeather or not the credential store provider is active
isCustomBooleanWeather or not the credential store provider is custom
credentialStoreApiTextValueStringGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>The list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>The list of credential store property definitions associated with the credential store provider

Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.

AttributesTypeDescription
credentialStoreInputDefIdLongThis is the unique Id of the credential store input definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
inputNameStringThe name of the credential store input definition
displayNameStringThe display name of the credential store input definition
descriptionStringThe description of the credential store input definition
inputDatatypeStringthe datatype associated with the credential store input definition
isRequiredBooleanWeather or not the credential store input definition is required
isEncryptedBooleanWeather or not the credential store input definition is encrypted
isActiveBooleanWeather or not the credential store input definition is active
minValueLongThe minimum value of the credential store input definition
maxValueLongThe maximum value of the credential store input definition
listDataStringThe list data associated with the credential store input definition
isMultiselectBooleanWeather or not the credential store input definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store input definition
displayColumnsIntegerThe number of display columns associated with the credential store input definition
defaultValueStringThe default value of the credential store input definition
lengthLongThe length of the credential store input definition
sortNumberIntegerThis is a number associated with the credential store input definition that sets their priority in a list of other credential store input definitions

Each credentialStorePropDef in the list of credentialStorePropDefs contains these attributes.

AttributesTypeDescription
credentialStorePropDefIdLongThis is the unique Id of the credential store property definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
propertyNameStringThe name of the credential store property definition
displayNameStringThe display name of the credential store property definition
descriptionStringThe description of the credential store property definition
propertyDatatypeStringthe datatype associated with the credential store property definition
isRequiredBooleanWeather or not the credential store property definition is required
isEncryptedBooleanWeather or not the credential store property definition is encrypted
isActiveBooleanWeather or not the credential store property definition is active
minValueLongThe minimum value of the credential store property definition
maxValueLongThe maximum value of the credential store property definition
listDataStringThe list data associated with the credential property input definition
isMultiselectBooleanWeather or not the credential store property definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store property definition
displayColumnsIntegerThe number of display columns associated with the credential store property definition
defaultValueStringThe default value of the credential store property definition
lengthLongThe length of the credential store property definition
sortNumberIntegerThis is a number associated with the credential store property definition that sets their priority in a list of other credential store property definitions

Response Codes

HTTP CodeDescription
201Credential Store Provider was created
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example with Child Rows

If the POST request receives the following JSON credential store provider object,

Credential Store Provider - 10000
{
	"description": "description of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreInputDefs": [
	{
		"inputName": "example_name_input",
		"inputDatatype": "Boolean",
		"isRequired": true,
		"isEncrypted": false,
		"isActive": true,
		"isMultiselect": true 
	}],
	"credentialStorePropDefs": [
	{
		"propertyName": "example_name_property",
		"propertyDatatype": "String",
		"isRequired": true,
		"isEncrypted": false,
		"isActive": true,
		"isMultiselect": true 	
	}],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefName": "credential store provider name"
}

The following credential store provider object will then be created as a new row in the database.

Credential 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",
	"updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

Example without Child Rows

If the POST request receives the following JSON credential store provider object,

Credential Store Provider - 10000
{
	"description": "description of credential store provider",
	"isActive": true,
 	"isCustom": true,
	"credentialStoreDefName": "credential store provider name"
}

The following credential store provider object will then be created as a new row in the database.

Credential Store Provider - 10000
{
{
	"description": "description of credential store provider",
	"implementationClass": null,
	"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"
}

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.

Request

AttributesTypeRequiredDescription
IdURLYesThe PUT will be performed on the credential store provider with the specified id that is found in the URL.
credentialStoreDefNameStringYesThe name of the credential store provider
descriptionStringNoThe description of the credential store provider
implementationClassStringNoThe implementation class of the credential store provider
isActiveBooleanYesWeather or not the credential store provider is active
isCustomBooleanYesWeather or not the credential store provider is custom
credentialStoreApiTextValueStringNoGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>NoThe list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>NoThe list of credential store property definitions associated with the credential store provider

Response

AttributesTypeDescription
credentialStoreDefIdLongThe id of the credential store provider
credentialStoreDefNameStringThe name of the credential store provider
descriptionStringThe description of the credential store provider
implementationClassStringThe implementation class of the credential store provider
isActiveBooleanWeather or not the credential store provider is active
isCustomBooleanWeather or not the credential store provider is custom
credentialStoreApiTextValueStringGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>The list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>The list of credential store property definitions associated with the credential store provider

Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.

AttributesTypeDescription
credentialStoreInputDefIdLongThis is the unique Id of the credential store input definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
inputNameStringThe name of the credential store input definition
displayNameStringThe display name of the credential store input definition
descriptionStringThe description of the credential store input definition
inputDatatypeStringthe datatype associated with the credential store input definition
isRequiredBooleanWeather or not the credential store input definition is required
isEncryptedBooleanWeather or not the credential store input definition is encrypted
isActiveBooleanWeather or not the credential store input definition is active
minValueLongThe minimum value of the credential store input definition
maxValueLongThe maximum value of the credential store input definition
listDataStringThe list data associated with the credential store input definition
isMultiselectBooleanWeather or not the credential store input definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store input definition
displayColumnsIntegerThe number of display columns associated with the credential store input definition
defaultValueStringThe default value of the credential store input definition
lengthLongThe length of the credential store input definition
sortNumberIntegerThis is a number associated with the credential store input definition that sets their priority in a list of other credential store input definitions

Each credentialStorePropDef in the list of credentialStorePropDefs contains these attributes.

AttributesTypeDescription
credentialStorePropDefIdLongThis is the unique Id of the credential store property definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
propertyNameStringThe name of the credential store property definition
displayNameStringThe display name of the credential store property definition
descriptionStringThe description of the credential store property definition
propertyDatatypeStringthe datatype associated with the credential store property definition
isRequiredBooleanWeather or not the credential store property definition is required
isEncryptedBooleanWeather or not the credential store property definition is encrypted
isActiveBooleanWeather or not the credential store property definition is active
minValueLongThe minimum value of the credential store property definition
maxValueLongThe maximum value of the credential store property definition
listDataStringThe list data associated with the credential property input definition
isMultiselectBooleanWeather or not the credential store property definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store property definition
displayColumnsIntegerThe number of display columns associated with the credential store property definition
defaultValueStringThe default value of the credential store property definition
lengthLongThe length of the credential store property definition
sortNumberIntegerThis is a number associated with the credential store property definition that sets their priority in a list of other credential store property definitions

Response Codes

HTTP CodeDescription
200Credential store provider was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Credential store provider not found
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

Credential 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": "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 PUT request at the following URL

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

And the PUT request receives the following JSON credential store provider object,

Credential Store Provider - 10000
{
	"isActive": true,
 	"isCustom": false,
	"credentialStoreInputDefs": [
	{
        "description": "description of credential store input definition",
        "inputName": "name_changed",
        "isEncrypted": false,
        "isActive": false,
        "isRequired": false,
        "isMultiselect": false,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11000
	}],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefName": "credential store provider name updated"
}

The PUT request would then update the credential store provider with Id 10000 and return the following JSON credential store provider object

CredentialStoreProvider - 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": null,
        "isEncrypted": false,
        "minValue": null,
        "isActive": false,
        "isRequired": false,
        "sortNumber": null,
        "displayRows": null,
        "isMultiselect": false,
        "inputDatatype": "Boolean",
        "credentialStoreInputDefId": 11000,
        "displayColumns": null,
        "listData": null,
        "credentialStoreDefId": 10000
	}],
	"credentialStorePropDefs": [],
	"credentialStoreApiTextValue": "//Groovy API Text",
	"credentialStoreDefId": 10000,
	"credentialStoreDefName": "credential store provider name updated",
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "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.

Request

AttributesTypeRequiredDescription
IdURLYesThe PUT will be performed on the credential store provider with the specified id that is found in the URL.
credentialStoreDefNameStringNoThe name of the credential store provider
descriptionStringNoThe description of the credential store provider
implementationClassStringNoThe implementation class of the credential store provider
isActiveBooleanNoWeather or not the credential store provider is active
isCustomBooleanNoWeather or not the credential store provider is custom
credentialStoreApiTextValueStringNoGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>NoThe list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>NoThe list of credential store property definitions associated with the credential store provider

Response

AttributesTypeDescription
credentialStoreDefIdLongThe id of the credential store provider
credentialStoreDefNameStringThe name of the credential store provider
descriptionStringThe description of the credential store provider
implementationClassStringThe implementation class of the credential store provider
isActiveBooleanWeather or not the credential store provider is active
isCustomBooleanWeather or not the credential store provider is custom
credentialStoreApiTextValueStringGroovy API text associated with the credential store provider
credentialStoreInputDefsList<CredentialStoreInputDef>The list of credential store input definitions associated with the credential store provider
credentialStorePropDefsList<CredentialStorePropDef>The list of credential store property definitions associated with the credential store provider

Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.

AttributesTypeDescription
credentialStoreInputDefIdLongThis is the unique Id of the credential store input definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
inputNameStringThe name of the credential store input definition
displayNameStringThe display name of the credential store input definition
descriptionStringThe description of the credential store input definition
inputDatatypeStringthe datatype associated with the credential store input definition
isRequiredBooleanWeather or not the credential store input definition is required
isEncryptedBooleanWeather or not the credential store input definition is encrypted
isActiveBooleanWeather or not the credential store input definition is active
minValueLongThe minimum value of the credential store input definition
maxValueLongThe maximum value of the credential store input definition
listDataStringThe list data associated with the credential store input definition
isMultiselectBooleanWeather or not the credential store input definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store input definition
displayColumnsIntegerThe number of display columns associated with the credential store input definition
defaultValueStringThe default value of the credential store input definition
lengthLongThe length of the credential store input definition
sortNumberIntegerThis is a number associated with the credential store input definition that sets their priority in a list of other credential store input definitions

Each credentialStorePropDef in the list of credentialStorePropDefs contains these attributes.

AttributesTypeDescription
credentialStorePropDefIdLongThis is the unique Id of the credential store property definition
credentialStoreDefIdLongThis is a foreign key to the parent credential store provider
propertyNameStringThe name of the credential store property definition
displayNameStringThe display name of the credential store property definition
descriptionStringThe description of the credential store property definition
propertyDatatypeStringthe datatype associated with the credential store property definition
isRequiredBooleanWeather or not the credential store property definition is required
isEncryptedBooleanWeather or not the credential store property definition is encrypted
isActiveBooleanWeather or not the credential store property definition is active
minValueLongThe minimum value of the credential store property definition
maxValueLongThe maximum value of the credential store property definition
listDataStringThe list data associated with the credential property input definition
isMultiselectBooleanWeather or not the credential store property definition is multiselect
displayRowsIntegerThe number of display rows associated with the credential store property definition
displayColumnsIntegerThe number of display columns associated with the credential store property definition
defaultValueStringThe default value of the credential store property definition
lengthLongThe length of the credential store property definition
sortNumberIntegerThis is a number associated with the credential store property definition that sets their priority in a list of other credential store property definitions

Response Codes

HTTP CodeDescription
200Credential store provider was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Credential store provider not found
500Unexpected internal server error

Example

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

Credential 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",
	"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 PATCH request at the following URL

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

And the PATCH request receives the following JSON credential store provider object,

Credential Store Provider - 10000
{
 	"isCustom": false,
	"credentialStoreInputDefs": [
	{
        "description": "new credential store input definition",
        "inputName": "new_input",
        "isEncrypted": false,
        "isActive": true,
        "isRequired": true,
        "isMultiselect": true,
        "inputDatatype": "Boolean",
	}],
	"credentialStoreDefName": "credential store provider name updated"
}

The PATCH request would then update the credential store provider with Id 10000 and return the  following JSON credential store provider object

User - 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",
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-10T06:32:19.147+0000",
    "versionNumber": 2,
    "createdBy": "fdadmin"
}