Auth Api Change Password
Changes the caller's own password (LOCAL accounts only) and clears mustChangePassword. A voluntary change keeps the current session and revokes every other active session of the user. A mandatory change (mustChangePassword was true) also revokes the current session and clears its cookie, and the body says reauthenticationRequired: true, so the client signs in again with the new password. While mustChangePassword is true this is one of the only operations allowed (with session and logout); all others answer 403 PASSWORD_CHANGE_REQUIRED. Five wrong current passwords within 15 minutes block further changes of that account until the window ends. Accessible to every authenticated role.
The caller's current password and the new password, which must satisfy the password policy and differ from the current one. There is no confirmation field.
Show optional properties
{
"currentPassword": "string",
"newPassword": "string"
}
{
"currentPassword": "<redacted>",
"newPassword": "Exampl3-Passw0rd!"
}
The caller's current password. A wrong value is answered with 401 INVALID_CREDENTIALS.
8-20 characters with at least one digit, one lowercase letter, one uppercase letter and one special character from !@#$%^&+=(){}_-, and no whitespace. A value that fails the policy is answered with 400 INVALID_PASSWORD_FORMAT.
200 OK; the password was changed. reauthenticationRequired says whether the current session was ended
{
"reauthenticationRequired": true
}
True after a mandatory change: the current session was revoked and the client must sign in again. False after a voluntary change, which keeps the current session.
Response Headers
no-store
Clears VTP_SESSION (Max-Age=0) after a mandatory change
400 Bad Request: INVALID_PASSWORD_FORMAT when newPassword fails the password policy, PASSWORD_REUSE when it equals the current password, or MALFORMED_REQUEST
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED without a session, or INVALID_CREDENTIALS when currentPassword is wrong
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead)
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: USER_NOT_FOUND
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
409 Conflict: PASSWORD_MANAGED_EXTERNALLY for an SSO account, whose password the identity provider manages
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
429 Too Many Requests: TOO_MANY_PASSWORD_ATTEMPTS with a Retry-After header in seconds after repeated wrong current passwords, or the gateway rate limit (a plain response with no JSON body)
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
Response Headers
Seconds until the account may try again (absent on the gateway response)
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"currentPassword":"string","newPassword":"string"}' https://{api_host}/api/v1/auth/change-password