Get Realm Creation Status
The Get Realm Creation Status API that will fetch the status of the Realm created.
Resource Informations
Name | Value |
---|---|
Requires authentication? | Yes |
Rate limited? | No |
Request
Request headers
Key | Value |
---|---|
Authorization | Bearer token |
HTTP request URL for SSMS
GET http://{{host}}/digitanium/v4/tenants/status
HTTP request URL for SHIFT
GET http://{hostname}/auth/realms/{tenantId}/v4_realm/status
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
No parameter fields are required.
Request body
No request body fields are required.
Response
Field Name | Type | Description |
---|---|---|
status | String | The consolidated status of realm based on signer and Identity user certificate status. (Other possible status: ACTIVE, BLOCKED, REQUESTED) |
iamStatus | String | It is marked as SUCCESS if the realm is present in the IDP. |
signerCertStatus | String | The status of the Signer Certificate creation of the realm. |
identityUserCertStatus | String | The status of the Identity User Certificate Status of the realm. |
internalIdentityUser | String | The status of the Internal Identity User certificate of the realm. |
externalIdentityUser | String | The status of the External Identity User certificate of the realm. |
authentication | String | The aunthentication certificate status of the Internal Identity User and External Identity User. |
encryption | String | The encryption certificate status of the Internal Identity User and External Identity User. |
signature | String | The signature certificate status of the Internal Identity User and External Identity User. |
Sample Response
{
"status": "BLOCKED",
"iamStatus": "SUCCESS",
"signerCertStatus": "BLOCKED",
"identityUserCertStatus": {
"externalIdentityUser": {
"authentication": "BLOCKED",
"encryption": "BLOCKED",
"signature": "BLOCKED"
},
"internalIdentityUser": {
"authentication": "BLOCKED",
"encryption": "BLOCKED",
"signature": "BLOCKED"
}
}
}
Response Status Information
Status Code | Status |
---|---|
200 | OK |
401 | Unauthorized |