Jump to

• Request
• Response

Get user status using userid and idstoreref

get

/oam/services/rest/access/api/v1/pswdmanagement/UserStatusRetriever/${userid}'

User status is retrieved for the input user. The userid is specified as path parameters in this API. The user needs to be present in the default identity store in OAM

Request

Path Parameters

• userid: string
  Input to uniquely identify user

Query Parameters

• userdetails(optional): string
  userdetails object in query parameter

Back to Top

Response

Supported Media Types

• application/json

200 Response

The user status has been retrieved successfully

Body ()

Root Schema : UserStatusChangeRequest

Type: object

Show Source

• enabled(optional): boolean
  if user is enabled, set to true. If disabled, set as false
• forcepwdchange(optional): boolean
  if user is forced to change password in the next login, set to true. Else set to false.
• unlocked(optional): boolean
  if user is unlocked, set to true. If user is locked, set to false
• username(optional): object userdetails

{
    "type":"object",
    "properties":{
        "username":{
            "$ref":"#/definitions/userdetails"
        },
        "enabled":{
            "type":"boolean",
            "description":"if user is enabled, set to true. If disabled, set as false"
        },
        "unlocked":{
            "type":"boolean",
            "description":"if user is unlocked, set to true. If user is locked, set to false"
        },
        "forcepwdchange":{
            "type":"boolean",
            "description":"if user is forced to change password in the next login, set to true. Else set to false."
        }
    }
}

Nested Schema : userdetails

Type: object

Show Source

• dn(optional): string
  the distinguished name of the user in the identity store
• idstoreref(optional): string
  idstore that the user belongs to
• tenantname(optional): string
  tenant name. Its always systemTenant
• username(optional): string
  the short name of the user

{
    "type":"object",
    "properties":{
        "tenantname":{
            "type":"string",
            "description":"tenant name. Its always systemTenant"
        },
        "idstoreref":{
            "type":"string",
            "description":"idstore that the user belongs to"
        },
        "dn":{
            "type":"string",
            "description":"the distinguished name of the user in the identity store"
        },
        "username":{
            "type":"string",
            "description":"the short name of the user"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top