Credential Store Provider API v2
- Victor Krieg
Owned by Victor Krieg
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 | URL | Yes | This is a URL parameter for the Id which is used to find and return a credential store provider |
Response
| Attributes | Type | Description |
|---|---|---|
| credentialStoreDefId | Long | The id of the credential store provider |
| credentialStoreDefName | String | The name of the credential store provider |
| description | String | The description of the credential store provider |
| implementationClass | String | The implementation class of the credential store provider |
| isActive | Boolean | Weather or not the credential store provider is active |
| isCustom | Boolean | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | The list of credential store property definitions associated with the credential store provider |
Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| credentialStoreInputDefId | Long | This is the unique Id of the credential store input definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| inputName | String | The name of the credential store input definition |
| displayName | String | The display name of the credential store input definition |
| description | String | The description of the credential store input definition |
| inputDatatype | String | the datatype associated with the credential store input definition |
| isRequired | Boolean | Weather or not the credential store input definition is required |
| isEncrypted | Boolean | Weather or not the credential store input definition is encrypted |
| isActive | Boolean | Weather or not the credential store input definition is active |
| minValue | Long | The minimum value of the credential store input definition |
| maxValue | Long | The maximum value of the credential store input definition |
| listData | String | The list data associated with the credential store input definition |
| isMultiselect | Boolean | Weather or not the credential store input definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store input definition |
| displayColumns | Integer | The number of display columns associated with the credential store input definition |
| defaultValue | String | The default value of the credential store input definition |
| length | Long | The length of the credential store input definition |
| sortNumber | Integer | This 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.
| Attributes | Type | Description |
|---|---|---|
| credentialStorePropDefId | Long | This is the unique Id of the credential store property definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| propertyName | String | The name of the credential store property definition |
| displayName | String | The display name of the credential store property definition |
| description | String | The description of the credential store property definition |
| propertyDatatype | String | the datatype associated with the credential store property definition |
| isRequired | Boolean | Weather or not the credential store property definition is required |
| isEncrypted | Boolean | Weather or not the credential store property definition is encrypted |
| isActive | Boolean | Weather or not the credential store property definition is active |
| minValue | Long | The minimum value of the credential store property definition |
| maxValue | Long | The maximum value of the credential store property definition |
| listData | String | The list data associated with the credential property input definition |
| isMultiselect | Boolean | Weather or not the credential store property definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store property definition |
| displayColumns | Integer | The number of display columns associated with the credential store property definition |
| defaultValue | String | The default value of the credential store property definition |
| length | Long | The length of the credential store property definition |
| sortNumber | Integer | This 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 Code | Description |
|---|---|
| 200 | Credential store provider was found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Credential store provider not found |
| 500 | Unexpected 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
| Attributes | Type | Required | Description |
|---|---|---|---|
| credentialStoreProviderId | Query - Long | No | Equals search |
| credentialStoreProviderName | Query - String | No | Contains ignore case search |
| implementationClass | Query - String | No | Contains ignore case search |
| isActive | Query - Boolean | No | Equals search |
| isCustom | Query - Boolean | No | Equals search |
Response
| Attributes | Type | Description |
|---|---|---|
| credentialStoreDefId | Long | The id of the credential store provider |
| credentialStoreDefName | String | The name of the credential store provider |
| description | String | The description of the credential store provider |
| implementationClass | String | The implementation class of the credential store provider |
| isActive | Boolean | Weather or not the credential store provider is active |
| isCustom | Boolean | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | The list of credential store property definitions associated with the credential store provider |
Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| credentialStoreInputDefId | Long | This is the unique Id of the credential store input definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| inputName | String | The name of the credential store input definition |
| displayName | String | The display name of the credential store input definition |
| description | String | The description of the credential store input definition |
| inputDatatype | String | the datatype associated with the credential store input definition |
| isRequired | Boolean | Weather or not the credential store input definition is required |
| isEncrypted | Boolean | Weather or not the credential store input definition is encrypted |
| isActive | Boolean | Weather or not the credential store input definition is active |
| minValue | Long | The minimum value of the credential store input definition |
| maxValue | Long | The maximum value of the credential store input definition |
| listData | String | The list data associated with the credential store input definition |
| isMultiselect | Boolean | Weather or not the credential store input definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store input definition |
| displayColumns | Integer | The number of display columns associated with the credential store input definition |
| defaultValue | String | The default value of the credential store input definition |
| length | Long | The length of the credential store input definition |
| sortNumber | Integer | This 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.
| Attributes | Type | Description |
|---|---|---|
| credentialStorePropDefId | Long | This is the unique Id of the credential store property definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| propertyName | String | The name of the credential store property definition |
| displayName | String | The display name of the credential store property definition |
| description | String | The description of the credential store property definition |
| propertyDatatype | String | the datatype associated with the credential store property definition |
| isRequired | Boolean | Weather or not the credential store property definition is required |
| isEncrypted | Boolean | Weather or not the credential store property definition is encrypted |
| isActive | Boolean | Weather or not the credential store property definition is active |
| minValue | Long | The minimum value of the credential store property definition |
| maxValue | Long | The maximum value of the credential store property definition |
| listData | String | The list data associated with the credential property input definition |
| isMultiselect | Boolean | Weather or not the credential store property definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store property definition |
| displayColumns | Integer | The number of display columns associated with the credential store property definition |
| defaultValue | String | The default value of the credential store property definition |
| length | Long | The length of the credential store property definition |
| sortNumber | Integer | This 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 Code | Description |
|---|---|
| 200 | Search successful and results returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected 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
| Attributes | Type | Required | Description |
|---|---|---|---|
| credentialStoreDefName | String | Yes | The name of the credential store provider |
| description | String | No | The description of the credential store provider |
| implementationClass | String | No | The implementation class of the credential store provider |
| isActive | Boolean | Yes | Weather or not the credential store provider is active |
| isCustom | Boolean | Yes | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | No | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | No | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | No | The list of credential store property definitions associated with the credential store provider |
Response
| Attributes | Type | Description |
|---|---|---|
| credentialStoreDefId | Long | The id of the credential store provider |
| credentialStoreDefName | String | The name of the credential store provider |
| description | String | The description of the credential store provider |
| implementationClass | String | The implementation class of the credential store provider |
| isActive | Boolean | Weather or not the credential store provider is active |
| isCustom | Boolean | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | The list of credential store property definitions associated with the credential store provider |
Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| credentialStoreInputDefId | Long | This is the unique Id of the credential store input definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| inputName | String | The name of the credential store input definition |
| displayName | String | The display name of the credential store input definition |
| description | String | The description of the credential store input definition |
| inputDatatype | String | the datatype associated with the credential store input definition |
| isRequired | Boolean | Weather or not the credential store input definition is required |
| isEncrypted | Boolean | Weather or not the credential store input definition is encrypted |
| isActive | Boolean | Weather or not the credential store input definition is active |
| minValue | Long | The minimum value of the credential store input definition |
| maxValue | Long | The maximum value of the credential store input definition |
| listData | String | The list data associated with the credential store input definition |
| isMultiselect | Boolean | Weather or not the credential store input definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store input definition |
| displayColumns | Integer | The number of display columns associated with the credential store input definition |
| defaultValue | String | The default value of the credential store input definition |
| length | Long | The length of the credential store input definition |
| sortNumber | Integer | This 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.
| Attributes | Type | Description |
|---|---|---|
| credentialStorePropDefId | Long | This is the unique Id of the credential store property definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| propertyName | String | The name of the credential store property definition |
| displayName | String | The display name of the credential store property definition |
| description | String | The description of the credential store property definition |
| propertyDatatype | String | the datatype associated with the credential store property definition |
| isRequired | Boolean | Weather or not the credential store property definition is required |
| isEncrypted | Boolean | Weather or not the credential store property definition is encrypted |
| isActive | Boolean | Weather or not the credential store property definition is active |
| minValue | Long | The minimum value of the credential store property definition |
| maxValue | Long | The maximum value of the credential store property definition |
| listData | String | The list data associated with the credential property input definition |
| isMultiselect | Boolean | Weather or not the credential store property definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store property definition |
| displayColumns | Integer | The number of display columns associated with the credential store property definition |
| defaultValue | String | The default value of the credential store property definition |
| length | Long | The length of the credential store property definition |
| sortNumber | Integer | This 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 Code | Description |
|---|---|
| 201 | Credential Store Provider was created |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected 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
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | The PUT will be performed on the credential store provider with the specified id that is found in the URL. |
| credentialStoreDefName | String | Yes | The name of the credential store provider |
| description | String | No | The description of the credential store provider |
| implementationClass | String | No | The implementation class of the credential store provider |
| isActive | Boolean | Yes | Weather or not the credential store provider is active |
| isCustom | Boolean | Yes | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | No | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | No | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | No | The list of credential store property definitions associated with the credential store provider |
Response
| Attributes | Type | Description |
|---|---|---|
| credentialStoreDefId | Long | The id of the credential store provider |
| credentialStoreDefName | String | The name of the credential store provider |
| description | String | The description of the credential store provider |
| implementationClass | String | The implementation class of the credential store provider |
| isActive | Boolean | Weather or not the credential store provider is active |
| isCustom | Boolean | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | The list of credential store property definitions associated with the credential store provider |
Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| credentialStoreInputDefId | Long | This is the unique Id of the credential store input definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| inputName | String | The name of the credential store input definition |
| displayName | String | The display name of the credential store input definition |
| description | String | The description of the credential store input definition |
| inputDatatype | String | the datatype associated with the credential store input definition |
| isRequired | Boolean | Weather or not the credential store input definition is required |
| isEncrypted | Boolean | Weather or not the credential store input definition is encrypted |
| isActive | Boolean | Weather or not the credential store input definition is active |
| minValue | Long | The minimum value of the credential store input definition |
| maxValue | Long | The maximum value of the credential store input definition |
| listData | String | The list data associated with the credential store input definition |
| isMultiselect | Boolean | Weather or not the credential store input definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store input definition |
| displayColumns | Integer | The number of display columns associated with the credential store input definition |
| defaultValue | String | The default value of the credential store input definition |
| length | Long | The length of the credential store input definition |
| sortNumber | Integer | This 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.
| Attributes | Type | Description |
|---|---|---|
| credentialStorePropDefId | Long | This is the unique Id of the credential store property definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| propertyName | String | The name of the credential store property definition |
| displayName | String | The display name of the credential store property definition |
| description | String | The description of the credential store property definition |
| propertyDatatype | String | the datatype associated with the credential store property definition |
| isRequired | Boolean | Weather or not the credential store property definition is required |
| isEncrypted | Boolean | Weather or not the credential store property definition is encrypted |
| isActive | Boolean | Weather or not the credential store property definition is active |
| minValue | Long | The minimum value of the credential store property definition |
| maxValue | Long | The maximum value of the credential store property definition |
| listData | String | The list data associated with the credential property input definition |
| isMultiselect | Boolean | Weather or not the credential store property definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store property definition |
| displayColumns | Integer | The number of display columns associated with the credential store property definition |
| defaultValue | String | The default value of the credential store property definition |
| length | Long | The length of the credential store property definition |
| sortNumber | Integer | This 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 Code | Description |
|---|---|
| 200 | Credential store provider was found and updated |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Credential store provider not found |
| 500 | Unexpected 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
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | The PUT will be performed on the credential store provider with the specified id that is found in the URL. |
| credentialStoreDefName | String | No | The name of the credential store provider |
| description | String | No | The description of the credential store provider |
| implementationClass | String | No | The implementation class of the credential store provider |
| isActive | Boolean | No | Weather or not the credential store provider is active |
| isCustom | Boolean | No | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | No | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | No | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | No | The list of credential store property definitions associated with the credential store provider |
Response
| Attributes | Type | Description |
|---|---|---|
| credentialStoreDefId | Long | The id of the credential store provider |
| credentialStoreDefName | String | The name of the credential store provider |
| description | String | The description of the credential store provider |
| implementationClass | String | The implementation class of the credential store provider |
| isActive | Boolean | Weather or not the credential store provider is active |
| isCustom | Boolean | Weather or not the credential store provider is custom |
| credentialStoreApiTextValue | String | Groovy API text associated with the credential store provider |
| credentialStoreInputDefs | List<CredentialStoreInputDef> | The list of credential store input definitions associated with the credential store provider |
| credentialStorePropDefs | List<CredentialStorePropDef> | The list of credential store property definitions associated with the credential store provider |
Each credentialStoreInputDef in the list of credentialStoreInputDefs contains these attributes.
| Attributes | Type | Description |
|---|---|---|
| credentialStoreInputDefId | Long | This is the unique Id of the credential store input definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| inputName | String | The name of the credential store input definition |
| displayName | String | The display name of the credential store input definition |
| description | String | The description of the credential store input definition |
| inputDatatype | String | the datatype associated with the credential store input definition |
| isRequired | Boolean | Weather or not the credential store input definition is required |
| isEncrypted | Boolean | Weather or not the credential store input definition is encrypted |
| isActive | Boolean | Weather or not the credential store input definition is active |
| minValue | Long | The minimum value of the credential store input definition |
| maxValue | Long | The maximum value of the credential store input definition |
| listData | String | The list data associated with the credential store input definition |
| isMultiselect | Boolean | Weather or not the credential store input definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store input definition |
| displayColumns | Integer | The number of display columns associated with the credential store input definition |
| defaultValue | String | The default value of the credential store input definition |
| length | Long | The length of the credential store input definition |
| sortNumber | Integer | This 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.
| Attributes | Type | Description |
|---|---|---|
| credentialStorePropDefId | Long | This is the unique Id of the credential store property definition |
| credentialStoreDefId | Long | This is a foreign key to the parent credential store provider |
| propertyName | String | The name of the credential store property definition |
| displayName | String | The display name of the credential store property definition |
| description | String | The description of the credential store property definition |
| propertyDatatype | String | the datatype associated with the credential store property definition |
| isRequired | Boolean | Weather or not the credential store property definition is required |
| isEncrypted | Boolean | Weather or not the credential store property definition is encrypted |
| isActive | Boolean | Weather or not the credential store property definition is active |
| minValue | Long | The minimum value of the credential store property definition |
| maxValue | Long | The maximum value of the credential store property definition |
| listData | String | The list data associated with the credential property input definition |
| isMultiselect | Boolean | Weather or not the credential store property definition is multiselect |
| displayRows | Integer | The number of display rows associated with the credential store property definition |
| displayColumns | Integer | The number of display columns associated with the credential store property definition |
| defaultValue | String | The default value of the credential store property definition |
| length | Long | The length of the credential store property definition |
| sortNumber | Integer | This 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 Code | Description |
|---|---|
| 200 | Credential store provider was found and updated |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Credential store provider not found |
| 500 | Unexpected 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"
}
The following macros are not currently supported in the footer:
- style