Jump to

• Request
• Response

Get Password policy using userid

get

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

REST API for getting the applicable password policy for the user. This can be used in an application to display the password rules for the user that the password need to conform to. The userid that the user belongs to in the default identity store are given as a path parameters. This API assumes that the user belongs to the default identity store.

Request

Path Parameters

• userid: string
  Input to uniquely identify user

Query Parameters

• isDescription(optional): boolean
  Whether password rules are supposed to come as description
• userdetails(optional): string
  userdetails object in query parameter

Back to Top

Response

Supported Media Types

• application/json

200 Response

Password policy assignment

Body ()

Root Schema : PolicyDescriptionResponse

Type: object

Show Source

• messages(optional): array messages

{
    "properties":{
        "messages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyMessage"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: object PolicyMessage

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

Nested Schema : PolicyMessage

Type: object

Show Source

• displayValue(optional): string
• resourceBundleKey(optional): string

{
    "properties":{
        "resourceBundleKey":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top