Validate user password

POST 
/api/web/v1/users/:userid/password/validate

Validate user password. Caller requires the USERPASSWORDS:EDIT permission.

Request

Path Parameters

userid stringrequired

The UUID of the user whose password is to be validated.

application/json

Body

required

ignorePasswordHistory boolean

If set to true, existing password history is ignored.

password string

New password value that needs to be validated.

Responses

200

Successful

application/json

Schema

Schema

adComplexity boolean

True if password meets the active directory complexity requirements.

alias boolean

True if password meets the userId requirements. Password must not contain user alias.

alphaNumeric boolean

True if password meets the alpha numeric requirements.

blacklisted boolean

True if password does not contain a blacklisted password.

directoryType string

Possible values: [ON_PREM, AZURE, AD_CONNECTOR]

Type of the directory the user is associated with, ON_PREM, AZURE or AD Connector.

fullName boolean

True if password meets the full name requirements. Full Name must not be in the password.

length boolean

True if password meets the length requirements.

lowerCase boolean

True if password meets the lower case requirements.

nondeterministicValidations string[]

List of validations that cannot be determined mostly due to user is AD managed.

numeric boolean

True if password meets the numeric requirements.

passwordHistory boolean

True if password does not match the history if enabled.

repeatedCharacters boolean

True if password meets the repeated characters requirements.

strength boolean

True if password meets the minimum strength requirements.

upperCase boolean

True if password meets the upper case requirements.

userID boolean

True if password meets the userId requirements. Password must not contain userId.

userPasswordStrength

object

UserPasswordStrength

score int32

Evaluated password strength score.

0:very weak | 1:weak | 2:average | 3:good | 4:strong

suggestions string[]

Suggestions on how the password strength can be improved.

Example (from schema)

{
  "adComplexity": true,
  "alias": true,
  "alphaNumeric": true,
  "blacklisted": true,
  "directoryType": "ON_PREM",
  "fullName": true,
  "length": true,
  "lowerCase": true,
  "nondeterministicValidations": [
    "string"
  ],
  "numeric": true,
  "passwordHistory": true,
  "repeatedCharacters": true,
  "strength": true,
  "upperCase": true,
  "userID": true,
  "userPasswordStrength": {
    "score": 3,
    "suggestions": "feedback.dictionary.suggestions.allUppercase"
  }
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...