UMA App
Use this API to access a resource on the resource server which is secured based on the given query parameters.
Resource Informations
| Name | Value |
|---|---|
| Requires authentication? | Yes |
| Rate limited? | No |
Request
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer token |
| Content-Type | application/json |
HTTP request URL for SSMS
POST https://{tenantId}.{hostname}/digitanium/v4/apps/uma?migrate=true&adminuser=demouser&adminpassword=pass
HTTP request URL for SHIFT
POST https://{hostname}/auth/realms/{tenantId}/v3_client/uma?migrate=true&adminuser=demouser&adminpassword=pass
note
API requests must be made over https. Calls made over plain http will fail.
Request body
No request body fields are required.
Query Parameters
| Parameter Name | Type | Description |
|---|---|---|
| migrate | boolean | If set to true the respective UMA roles will be assigned to all the existing users. |
| adminuser | String | Provide a name for the Admin user. |
| adminpass | String | Set a password for the Admin user. |
Request Parameters
| Field Name | Type | Description |
|---|---|---|
| appName | String | Unique appName of the application. |
Response
| Field Name | Type | Description |
|---|---|---|
| message | String | Message explains result of the API call. Refer Response status Information for details. |
| status | String | The status of the API call. Refer Response status Information for details. |
| subSystem | Integer | subSystem categorizes the type of API that has been called. Refer Subsystem details for details. |
Sample Response
{
"message": "Created app and migrated users successfully",
"status": "OK",
"subSystem": 2
}
Response Status Information
| Status Code | Status | Message |
|---|---|---|
| 200 | OK | Created app and migrated users successfully |
| 400 | BAD_REQUEST | Admin password should not be null or empty |
| 401 | Unauthorized | HTTP 401 Unauthorized |
| 409 | CONFLICT | App already exists |