Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-23231323.7 KB
Users

Changes the user's password

Changes the user's password in Cognito

put/users/self/password

Request body

type'NewPasswordRequired' | 'ForgottenPassword' required
emailstring required
passwordstring required
sessionstring

Required if type is NewPasswordRequired

verification_tokenstring

Required if type is ForgottenPassword

Example request

{
  "type": "NewPasswordRequired",
  "email": "email@ons.gov.uk"
}

Response

Password changed

expirationTimestring

Expiration Time, UTC ISO 8601

refreshTokenExpirationTimestring

Refresh Token Expiration Time, UTC ISO 8601

Example response

{
  "expirationTime": "YYYY-MM-DD hh:mm:ssZ",
  "refreshTokenExpirationTime": "YYYY-MM-DD hh:mm:ssZ"
}