U4IDS Admin API

The following endpoints resources are available through the Admin Web API:

Method	Resource	endpoint	Description
POST	Client	/api/admin/clients	Creates a new client
GET	Client	/api/admin/clients/{clientId}	Get client with the given ID
GET	Client	/api/admin/clients/	Get all registered clients
DELETE	Client	/api/admin/clients/{clientId}
PUT	Client	/api/admin/clients/{clientId}
PATCH	Client	/api/admin/clients/{clientId}
POST	Client Secret	api/admin/clients/{clientId}/secrets	creates a new client secret
POST	Scope	/api/admin/scopes
GET	Scope	/api/admin/scopes/{scopeName}	Get scope with the given ID
GET	Scope	/api/admin/scopes	Get all registered scopes
DELETE	Scope	/api/admin/scopes/{scopeName}
PUT	Scope	/api/admin/scopes/{scopeName}
PATCH	Scope	/api/admin/scopes/{scopeName}
POST	Scope Secret	/api/admin/scopes/{scopeId}/secrets	Creates a new scope secret
POST	Tenant	/api/admin/tenants
GET	Tenant	/api/admin/tenants
GET	Tenant	/api/admin/tenants/{tenantId}
DELETE	Tenant	/api/admin/tenants/{tenantId}
PUT	Tenant	/api/admin/tenants/{tenantId}
PATCH	Tenant	/api/admin/tenants/{tenantId}

Client registration

See Client registration for more details.

Tenant registration

See Tenant registration for details.

Scope registration

See Scope registration for details.

Secrets Registration

Secrets can be defined for clients or scopes. Secrets allow the use of client and scope resources in a trusted manner (so that only the clients that know the secret can use them). Please Secret registration for details.

Using PATCH

JSON Patch expresses a sequence of operations to execute on a target JSON document or to a data structure that can be serialized to a similar document. The PATCH document consists of an array of JSON-objects where each object consists of one operation. Each operation is executed in the sequence they appear in the array, and each operation is based on the result of the previous operation. Evaluation is continued until all operations are successfully executed or until an error has occurred. In the result of the PATCH operation, the entire updated object will be returned.

PATCH operations

U4IDS-Admin API supports the following PATCH operations:

Operation	Path	Value	Description
add	.../-, .../0	DTO	Adds an element to a list propery. Using '-' at the end of the path will append element at the end of the list. Specifying the index value will insert the element at this index (all elements that proceed after it will be shifted right)
remove	.../0	---	Removes an element from a list property. All elements that proceed after the removed element will be shifted left.
replace	.../0, .../prop	DTO or value	Replaces en element in a list property or sets the property to a given value.

Example 1: PATCH document for appending a new entry to redirectUris of client object.

[
    { "op":"add","path":"/redirectUris/-","value":"http://unit4businessworld.xyz/Login/login.aspx" }
]

Example 2: PATCH document for removing an entry from redirectUris, index 0.

[
    { "op":"remove","path":"/redirectUris/0" }
]

Example 3: PATCH document for replacing the flow property to "Hybrid"

[
    { "op":"replace","path":"/flow","value":"Hybrid" }
]

API Explorer for testing

A built-in API explorer is available for developers to test the Admin API.