Jump to

• Request
• Response

Change user status using userid and idstoreref

put

/oam/services/rest/access/api/v1/pswdmanagement/UserStatusChanger/${userid}/${idstoreref}

User status is changed as per input specifications. The specifications tells whether user is enabled/disable forcedPasswordreset, locked/unlocked. These status of the user can be changed via this API. The userid and the idstoreref that the user belongs to are specified as path parameters in this API.

Request

Path Parameters

• idstoreref: string
  idstore that the user belongs to
• userid: string
  Input to uniquely identify user

Query Parameters

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

Body ()

This is the request object which uniquely identifies the user and changes the status as per the input specification

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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The user status has been changed successfully

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top