Order Management System REST API - IdentitySource Controller
The identity/source/bycode/<source>
URI provides manipulation of a specific Identity Source.
Retrieves an Identity Source
Section titled “Retrieves an Identity Source”GET /identity/source/bycode/<source>
Retrieves the details of a registered Identity Source.
Requires the Admin
feature permission.
URL Parameters
Section titled “URL Parameters”Parameter | Description |
---|---|
source | A URL-encoded Identity Source name. |
Response
Section titled “Response”Code | Status | Description |
---|---|---|
200 | Success | Content is a single IdentitySource object. |
403 | Failure | The authenticated identity does not have the Admin permission. |
404 | Failure | The Identity Source does not exist. |
Removes an Identity Source
Section titled “Removes an Identity Source”DELETE /identity/source/bycode/<source>
Removes a registered Identity Source.
Requires the Admin
feature permission.
URL Parameters
Section titled “URL Parameters”Parameter | Description |
---|---|
source | A URL-encoded Identity Source name. |
Response
Section titled “Response”Code | Status | Description |
---|---|---|
204 | Success | Update completed successfully, or the update would make no changes. |
403 | Failure | The authenticated identity does not have the Admin permission. |
422 | Failure | A failure occurred. Content is a JSON array of one or more error codes describing the problem. |