Jump to

• Request
• Response
• Examples

Get User Status Based on User ID

get

/iam/governance/selfservice/api/v1/users/{uuid}/status

Returns the status of the specified user. The valules which will be returned depend on the state the user is in OIM. The probable values are "Active, Disabled, Deleted, Disabled Until Start Date".

Request

Supported Media Types

• application/json

Path Parameters

• uuid: string
  Unique identifier of the User whose status is to be returned.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : StatusResponse

Type: object

Show Source

• id(optional): string
• links(optional): array links
• name(optional): string
• status(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top

Examples

This retrieves the status for a given user.. The information shown here is against a pseudo system and servers as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/users/1/status

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24/status"
        }
    ],
    "status": "Active",
    "id": "24",
    "name": "Beatrix Kiddo",
    "usr_locked": "0"
}

Back to Top