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.
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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
...
,
"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
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "description": "description of credential store provider", "implementationClass": "implementation class of credential store provider", "isActive": true, "isCustom": true, "credentialStoreInputDefs": [], "credentialStorePropDefs": [], "credentialStoreApiTextValue": null, "credentialStoreDefId": 10000, "credentialStoreDefName": "implementation class of credential store provider name", "isActiveupdatedBy": true"fdadmin", "isCustomcreatedOn": 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" } |
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 | ||
---|---|---|
| ||
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 |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "description": "description of credential store provider", "implementationClass": "implementation class of credential store provider" provider", "isActive": true, "isCustom": true, "credentialStoreInputDefs": [], "credentialStorePropDefs": [], "credentialStoreApiTextValue": null, "credentialStoreDefId": 10000, "implementationClasscredentialStoreDefName": "implementation class of credential store provider name", "isActiveupdatedBy": true,"fdadmin", "isCustomcreatedOn": 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" } |
When we run a GET request at the following URL
...
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "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", "isActiveupdatedBy": true"fdadmin", "isCustomcreatedOn": 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 | ||||
---|---|---|---|---|
| ||||
{ "description": "description of credential store provider", "implementationClass": null, "isActive": true, "isCustom": true, "credentialStoreInputDefs": [ { "length": null, "defaultValue": null, "displayName": null, "description": null": null, "inputName": "EXAMPLE_NAME_INPUT", "maxValue": null, "isEncrypted": false, "minValue": null, "isActive": true, "inputNameisRequired": "EXAMPLE_NAME_INPUT"true, "maxValuesortNumber": null, "isEncrypteddisplayRows": falsenull, "minValueisMultiselect": nulltrue, "isActiveinputDatatype": true"Boolean", "isRequiredcredentialStoreInputDefId": true11000, "sortNumberdisplayColumns": null, "displayRowslistData": null, "isMultiselectcredentialStoreDefId": true10000 }], "credentialStorePropDefs": [ "inputDatatype { "length": "Boolean"null, "credentialStoreInputDefIddefaultValue": 11000null, "displayColumnsdisplayName": null, "listDatadescription": null, "credentialStoreDefId": 10000 }], "credentialStorePropDefs": [ { "lengthpropertyName": "EXAMPLE_NAME_PROPERTY", "maxValue": null, "defaultValueisEncrypted": nullfalse, "displayNameminValue": null, "descriptionisActive": nulltrue, "propertyNameisRequired": "EXAMPLE_NAME_PROPERTY"true, "maxValuesortNumber": null, "isEncrypteddisplayRows": falsenull, "minValueisMultiselect": nulltrue, "isActivepropertyDatatype": true"String", "isRequiredcredentialStorePropDefId": true11001, "sortNumberdisplayColumns": null, "displayRowslistData": null, "credentialStoreDefId": 10000 }], "credentialStoreApiTextValue": "//Groovy API Text", "isMultiselectcredentialStoreDefId": true10000, "credentialStoreDefName": "credential store provider "propertyDatatypename", "updatedBy": "Stringfdadmin", "credentialStorePropDefIdcreatedOn": 11001, "2021-09-01T17:23:18.288+0000", "displayColumnsupdatedOn": null, "listData": null, "2021-09-01T17:23:18.288+0000", "credentialStoreDefIdversionNumber": 10000 }]1, "credentialStoreApiTextValue": "//Groovy API Text", "credentialStoreDefIdcreatedBy": 10000, "credentialStoreDefName": "credential store provider name" "fdadmin" } |
Example without Child Rows
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ { "description": "description of credential store provider" store provider", "implementationClass": null, "isActive": true, "isCustom": true, "credentialStoreInputDefs": [], "credentialStorePropDefs": [], "implementationClasscredentialStoreApiTextValue": null, "isActivecredentialStoreDefId": true10000, "isCustomcredentialStoreDefName": true "credential store provider name", "credentialStoreInputDefsupdatedBy": []"fdadmin", "credentialStorePropDefscreatedOn": [], "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 | ||||
---|---|---|---|---|
| ||||
{ "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, "credentialStorePropDefIdcredentialStoreDefId": 1100110000, "credentialStoreDefName": "credential store provider "displayColumnsname", "updatedBy": null, "fdadmin", "listDatacreatedOn": null"2021-09-01T17:23:18.288+0000", "credentialStoreDefId": 10000 }], "credentialStoreApiTextValue": "null, "credentialStoreDefId": 10000, "credentialStoreDefName": "credential store provider name"updatedOn": "2021-09-01T17:23:18.288+0000", "versionNumber": 1, "createdBy": "fdadmin" } |
When we run a PUT request at the following URL
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "description": null, "implementationClass": null, "isActive": true, "isCustom": false, "credentialStoreInputDefs": [ { "length": null, "defaultValue": null, "displayName": null, "description": "description of credential store input definition" definition", "inputName": "NAME_CHANGED", "maxValue": null, "isEncrypted": false, "minValue": null, "inputNameisActive": "NAME_CHANGED"false, "maxValueisRequired": nullfalse, "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.
Info | ||
---|---|---|
| ||
http://host:port/flexdeploy/rest/v2/administration/security/credentialstoreprovider/{Id} |
...
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
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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 null, "propertyName": "EXAMPLE_NAME_PROPERTY", "maxValue": null, "isEncrypted": false, "descriptionminValue": null, "propertyNameisActive": "EXAMPLE_NAME_PROPERTY"true, "maxValueisRequired": nulltrue, "isEncryptedsortNumber": falsenull, "minValuedisplayRows": null, "isActiveisMultiselect": true, "isRequiredpropertyDatatype": true"String", "sortNumbercredentialStorePropDefId": null11001, "displayRowsdisplayColumns": null, "isMultiselectlistData": truenull, "propertyDatatypecredentialStoreDefId": "String", "credentialStorePropDefId": 11001, "displayColumns": null, 10000 }], "credentialStoreApiTextValue": "//Groovy API Text", "credentialStoreDefId": 10000, "credentialStoreDefName": "credential store provider name", "updatedBy": "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 | ||||
---|---|---|---|---|
| ||||
{ "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", "listDatacreatedOn": null"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" } |