Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Create, Update, and Delete IdentityProvider configuration data.

Client Object Reference

IdentityResource Object Reference

ApiResource 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 obects can contain the Clients, IdentityResources, and ApiResources 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 proerties as keys to determine which object to performe the update operation on. Those proerty values cannot be updated.

Name

Type

Description

Create

object

Can contain the Clients, IdentityResources, and ApiResources lists to create as needed.

Update

object

Can contain the Clients, IdentityResources, and ApiResources lists update as needed.

Delete

object

Can contain ClientIdList, IdentityResourceNameList, and ApiResourceNameList string arrays as needed

ClientIdList

array of strings

As an optional Child of the Delete object, it contains a list of Client IDs to be deleted.

IdentityResourceNameList

array of strings

As an optional Child of the Delete object, it contains a list of Identity Resource Names to be deleted.

ApiResourceNameList

array of strings

As an optional Child of the Delete object, it contains a list of API Resource Names to be deleted.

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

Status: 200 OK

  • No labels