Versions Compared

Key

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

...

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store name"
}

When we run a GET request at the following URL

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

The GET request would return the following JSON credential store object

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store name"
}

GET (Using Query Parameters)

This GET service will return a list of credential stores in the form of JSON objects based on the query parameters id, name, implementation class, is active, and is custom. Credential stores 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 stores.

Info
titleAPI URLs

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

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

credentialStoreId={id}

credentialStoreName={name}

isActive={boolean}

credentialStoreDefId={id}

Examples:
To search by name only:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore?credentialStoreName=Name

To search by NAME IS ACTIVE:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore?credentialStoreName=Name&isActive=true

Request

...

Response Codes

...

Example

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store name"
}

When we run a GET request at the following URL

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

The GET request would return the following JSON environment object

Code Block
themeEclipse
titleCredential Store Provider - 10000
[
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	",
	"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/credentialstore/10000

The GET request would return the following JSON credential store object

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store 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 stores in the form of JSON objects based on the query parameters id, name, implementation class, is active, and is custom. Credential stores 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 stores.

Info
titleAPI URLs

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

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

credentialStoreId={id}

credentialStoreName={name}

isActive={boolean}

credentialStoreDefId={id}

Examples:
To search by name only:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore?credentialStoreName=Name

To search by NAME IS ACTIVE:

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore?credentialStoreName=Name&isActive=true

Request

AttributesTypeRequiredDescription
credentialStoreIdQuery - LongNoEquals search
credentialStoreNameQuery - StringNoContains ignore case search
isActiveQuery - BooleanNoEquals search
credentialStoreDefIdQuery - LongNoEquals search

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

Response Codes

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

Example

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store name",
	"updatedBy": "fdadmin"
}
]

POST

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

Info
titleAPI URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore

Request

...

Response Codes

...

Example with Properties

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropDefId": 12001,
		"propertyValue": "property value"
	}],
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name"
}

The following credential store object will then be created as a new row in the database. In this case, the credential store provider with id 11001 has 2 property definitions. See Credential Store Provider API v2

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropertyId": 13000,
		"credentialStorePropDefId": 12000,
		"credentialStoreId": 10000,
		"propertyValue": "*****",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
    "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/credentialstore?credentialStoreName=credential&isActive=true

The GET request would return the following JSON environment object

Code Block
themeEclipse
titleCredential Store Provider - 10000
[
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store 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 with the same attributes as the given JSON object.

Info
titleAPI URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore

Request

AttributesTypeRequiredDescription
credentialStoreNameStringYesThe name of the credential store
descriptionStringNoThe description of the credential store
isActiveBooleanYesWhether or not the credential store is active
credentialStorePropertiesList<CredentialStoreProperty>NoThe list of credential store properties associated with the credential store
credentialStoreDefIdLongYesThe id of the credential store provider associated with the credential store

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

Response Codes

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

Example with Properties

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropDefId": 12001,
		"propertyValue": "property value"
	}],
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name",
}

Example without Properties

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

The following credential store object will then be created as a new row in the database. In this case, the credential store provider with id 11001 has 2 property definitions. See Credential Store Provider API v2

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreDefIdcredentialStoreProperties": [
11001,	{
		"credentialStoreNamecredentialStorePropertyId": 13000,
		"credential store name"
}

The following credential store object will then be created as a new row in the database. In this case, the credential store provider with id 11000 has no property definitions. See Credential Store Provider API v2

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11000,
	"credentialStoreName": "credential store name"
}

PUT

This PUT service will update all attributes of a credential store with the given Id based on the attributes of a JSON object parameters. Attributes that are not provided will be defaulted.

Info
titleAPI URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore/{Id}

Request

...

Response Codes

...

Example

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store"credentialStorePropDefId": 12000,
		"credentialStoreId": 10000,
		"propertyValue": "*****",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store 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 Properties

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name"
}

The following credential store object will then be created as a new row in the database. In this case, the credential store provider with id 11000 has no property definitions. See Credential Store Provider API v2

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [],
	{
		"credentialStorePropertyIdcredentialStoreId": 1300010000,
		"credentialStorePropDefIdcredentialStoreDefId": 1200011000,
		"credentialStoreIdcredentialStoreName": 10000"credential store name",
		"propertyValueupdatedBy": "default property valuefdadmin",
		"isEncrypted": true 	}, 	{ 		"credentialStorePropertyIdcreatedOn": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "default property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store 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 with the given Id based on the attributes of a JSON object parameters. Attributes that are not provided will be defaulted.

Info
titleAPI URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore/

...

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store changed",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropDefId": 12001,
		"propertyValue": "new property value",
	}],
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name changed"
}

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

Code Block
themeEclipse
titleCredentialStoreProvider - 10000
{ "description": "description of credential store changed", "isActive":

{Id}

Request

AttributesTypeRequiredDescription
IdURLYesThe PUT will be performed on the credential store with the specified id that is found in the URL.
credentialStoreNameStringYesThe name of the credential store
descriptionStringNoThe description of the credential store
isActiveBooleanYesWhether or not the credential store is active
credentialStorePropertiesList<CredentialStoreProperty>NoThe list of credential store properties associated with the credential store
credentialStoreDefIdLongYesThe id of the credential store provider associated with the credential store

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

Response Codes

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

Example

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropertyId": 13000,
		"credentialStorePropDefId": 12000,
		"credentialStoreId": 10000,
		"propertyValue": "*****default property value",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "newdefault property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name",
changed	"updatedBy"
}

PATCH

This PATCH service will update an existing credential store 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. Child rows that are included in a PATCH will be added, but existing rows will still remain.

Info
titleAPI URL
http:/
: "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/credentialstore/

...

Request

...

Response Codes

...

Example

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

...

themeEclipse
titleCredential Store Provider - 10000

...

10000

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store changed",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropDefId": 12001,
		"propertyValue": "new property value",
	}],
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name changed"
}

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

Code Block
themeEclipse
titleCredentialStoreProvider - 10000
{
	"description": "description of credential store changed",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropertyId": 13000,
		"credentialStorePropDefId": 12000,
		"credentialStoreId": 10000,
		"propertyValue": "*****",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "new property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name changed",
	"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 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. Child rows that are included in a PATCH will be added, but existing rows will still remain.

Info
titleAPI URL

http://host:port/flexdeploy/rest/v2/administration/security/credentialstore/{Id}

Request

AttributesTypeRequiredDescription
IdURLYesThe PUT will be performed on the credential store with the specified id that is found in the URL.
credentialStoreNameStringNoThe name of the credential store
descriptionStringNoThe description of the credential store
isActiveBooleanNoWhether or not the credential store is active
credentialStorePropertiesList<CredentialStoreProperty>NoThe list of credential store properties associated with the credential store
credentialStoreDefIdLongYesThe id of the credential store provider associated with the credential store

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

Response Codes

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

Example

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"description": "description of credential store",
	"isActive": true,
	"credentialStoreProperties": [
	{
		"credentialStorePropertyId": 13000,
		"credentialStorePropDefId": 12000,
		"credentialStoreId": 10000,
		"propertyValue": "default property value",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "default property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store 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/credentialstore/10000

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

Code Block
themeEclipse
titleCredential Store Provider - 10000
{
	"isActive": false,
	"credentialStoreProperties": [
	{
		"credentialStorePropDefId": 12001,
		"propertyValue": "defaultnew property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name"
}

When we run a PATCH request at the following URL

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

...

 name changed"
}

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

Code Block
themeEclipse
titleCredential Store Provider User - 10000
{
	"description": "description of credential store",
	"isActive": false,
	"credentialStoreProperties": [
	{
		"credentialStorePropDefIdcredentialStorePropertyId": 1200113000,
		"propertyValuecredentialStorePropDefId": "new property value"12000,
	}],
	"credentialStoreDefIdcredentialStoreId": 1100110000,
		"credentialStoreNamepropertyValue": "credential store name changed"
}

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

Code Block
themeEclipse
titleUser - 10000
{
	"description": "description of credential store",
	"isActive": false,
	"credentialStoreProperties": [
	{
		"credentialStorePropertyId": 13000,
		"credentialStorePropDefId": 12000,
		"credentialStoreId": 10000,
		"propertyValue": "*****",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "new property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name changed*****",
		"isEncrypted": true
	},
	{
		"credentialStorePropertyId": 13001,
		"credentialStorePropDefId": 12001,
		"credentialStoreId": 10000,
		"propertyValue": "new property value",
		"isEncrypted": false
	}],
	"credentialStoreId": 10000,
	"credentialStoreDefId": 11001,
	"credentialStoreName": "credential store name changed",
	"updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-10T06:32:19.147+0000",
    "versionNumber": 2,
    "createdBy": "fdadmin"
}