Create, Update, and Delete Identity Provider configuration data.
IdentityResource Object Reference
Request
Method: POST
URI: /api/configuration/editor
Headers
Name | Type | Description |
|---|---|---|
X-SurePassID-Api-Key | string | An API Key with 'Editor' role. |
Post Data
There are three objects that can be included as needed Create, Update and Delete. The Create and Update objects can contain the Clients, IdentityResources, and ApiResources object lists as needed. The Delete object can contain ClientIdList, IdentityResourceNameList, and ApiResourceNameList string arrays as needed.
The Update object uses the Client.ClientId, IdentityResource.Name, and ApiResource.Name properties as keys to determine which object to perform the update operation on. Those property values cannot be updated.
Name | Type | Description |
|---|---|---|
Create | object | Can contain the |
Update | object | Can contain the |
Delete | object | Can contain |
ClientIdList | array of strings | As an optional Child of the |
IdentityResourceNameList | array of strings | As an optional Child of the |
ApiResourceNameList | array of strings | As an optional Child of the |
Post Data Example
{
"Create": {
"Clients": [
<ARRAY OF CLIENT OBJECTS TO CREATE>
],
"IdentityResources": [
<ARRAY OF IDENTITY RESOURCE OBJECTS TO CREATE>
],
"ApiResources": [
<ARRAY OF API RESOURCE OBJECTS TO CREATE>
]
},
"Update": {
"Clients": [
<ARRAY OF CLIENT OBJECTS TO UPDATE>
],
"IdentityResources": [
<ARRAY OF IDENTITY RESOURCE OBJECTS TO UPDATE>
],
"ApiResources": [
<ARRAY OF API RESOURCE OBJECTS TO UPDATE>
]
},
"Delete": {
"ClientIdList": [
"client-id"
],
"IdentityResourceNameList": [
"identity-resource-name"
],
"ApiResourceNameList": [
"api-resource-name"
]
}
}
Response
Create Success
Status: 200 OK
{
"CreateClients": [
{
"Key": "postman-client",
"Message": "Client creation successful.",
"Successful": true
}
],
"CreateApiResources": [
{
"Key": "postman-api-resource",
"Message": "ApiResource creation successful.",
"Successful": true
}
],
"CreateIdentityResources": [
{
"Key": "postman-identity-resource",
"Message": "IdentityResource creation successful.",
"Successful": true
}
]
}
Update Success
Status: 200 OK
{
"UpdateClients": [
{
"Key": "postman-client",
"Message": "Client successfully updated.",
"Successful": true
}
],
"UpdateApiResources": [
{
"Key": "postman-api-resource",
"Message": "ApiResource successfully updated.",
"Successful": true
}
],
"UpdateIdentityResources": [
{
"Key": "postman-identity-resource",
"Message": "IdentityResource successfully updated.",
"Successful": true
}
]
}
Delete Success
Status: 200 OK
{
"DeleteClients": [
{
"Key": "postman-client",
"Message": "Client deletion successful.",
"Successful": true
}
],
"DeleteApiResources": [
{
"Key": "postman-api-resource",
"Message": "ApiResource deletion successful.",
"Successful": true
}
],
"DeleteIdentityResources": [
{
"Key": "postman-identity-resource",
"Message": "IdentityResource deletion successful.",
"Successful": true
}
]
}