User Creation Status

When a new user is created in mID Provider (IAM), verify whether the user is provisioned appropriately across all the downstream systems.

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

GET https://{tenantId}.{hostname}/digitanium/v4/users/{userName}/provision/status

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_user/{userName}/provision/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
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.
data	Array	User status details for the given userId. Refer Data Representation for details.

Sample Response

{
    "message": "User status fetched successfully",
    "status": "Success",
    "subSystem": 5,
    "data": {
        "iamStatus": true,
        "ssmsStatus": true,
        "mPowerStatus": true
    }
}

Data Representation

Field Name	Type	Description
iamStatus	boolean	If true the user is created successfully in IAM. If false the user is not created.
ssmsStatus	boolean	If true the user is created successfully in SSMS. If false the user is not created.
mPowerStatus	boolean	If true the user is created successfully in SCP-Addressbook. If false the user is not created.

Response Status Information

Status Code	Status	Message
200	Success	User status fetched successfully
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist