Jump to

• Request
• Response

Validate Password using userid and idstoreref

post

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

Passwords needs to conform to specific password policy for the given user.This API allows validation of password for a specific user. If password is valid 200 is returned. Else 400 with list of errors are returned. In this API, the userid and idstore that the user belongs to are specified as path parameters.

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 ()

The request object

Root Schema : ValidatePasswordRequest

Type: object

Show Source

• password: string
  password to be validated.
• username: object userdetails

{
    "type":"object",
    "properties":{
        "username":{
            "$ref":"#/definitions/userdetails"
        },
        "password":{
            "type":"string",
            "description":"password to be validated."
        }
    }
}

Nested Schema : userdetails

Type: object

Show Source

• dn: string
  the distinguished name of the user in the identity store
• idstoreref: string
  idstore that the user belongs to
• tenantname: string
  tenant name
• username: string
  the short name of the user

{
    "type":"object",
    "properties":{
        "tenantname":{
            "type":"string",
            "description":"tenant name"
        },
        "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"
        }
    }
}

Response

Supported Media Types

• application/json

200 Response

Password is valid

Body ()

Root Schema : ValidatePasswordResponse

Type: object

Show Source

• isValid: boolean
• messages: array messages

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

Nested Schema : messages

Type: array

Show Source

• [0]: object PolicyMessage

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

Nested Schema : PolicyMessage

Type: object

Show Source

• displayValue: string
• resourceBundleKey: string

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

400 Response

Password validation failed

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error