Validate the proposed password

validate the password and return a score

post/v2/users/self/password/validate

Request body

passwordstring required

a password that passes validation

Example request

{
  "password": "My_strong_password"
}

Response

the password was checked and a score returned

scoreinteger

More secure passwords are given a higher score. <P> For a password to be acceptable for use in Velo, it must score at least 3

validboolean

if true then the password can be accepted

warningstring

Any warning message as a reason for the given score.

suggestionsstring[]

Example response

{
  "valid": true,
  "score": 2,
  "warning": "Historic Password",
  "suggestions": [
    "[password has been used before]",
    "[password has been used before]"
  ]
}

Changes

Changed in 5 of the 50 revisions of this API.12319

Jul 13, 202605c3f09fc50a2See the full diff
- ▲
  the password request property's maxLength was decreased to 64
  request-property-max-length-decreased
- ▲
  the password request property's minLength was increased from 8 to 10
  request-property-min-length-increased
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2020dd71433847a6318See the full diff
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 400
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from / to object/ for status 403
  response-property-type-changed
- ○
  added the optional property errors/items/errorCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorCode to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/errorData to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property errors/items/localisationDetails to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property httpStatusCode to the response with the 403 status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 28, 20201b2abf26b5d663See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 400
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 403
  response-body-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 400
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 401
  response-property-type-changed
- ▲
  the errors/items/ response's property type/format changed from object/ to / for status 403
  response-property-type-changed
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 400
  response-property-enum-value-added
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 401
  response-property-enum-value-added
- ●
  added the new requestParam enum value to the errors/items/locationType response property for the response status 403
  response-property-enum-value-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 11, 2019a0b19fa311c01See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 15, 2019ced8e167a97c1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history