Changes the password: a new auth key and a rewrapped master key.
The KDF salt is left as is, so the recovery credential keeps working.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Password change. The KDF salt is fixed for the account’s life — the recovery credential shares it — so only the auth key and wrapped master key change.
object
Base64 current auth key, re-verified before the change.
Base64 new auth key.
Base64 master key wrapped by the new password-derived wrap key.
Examplegenerated
{ "currentAuthKey": "example", "newAuthKey": "example", "newWrappedMasterKey": "example"}Responses
Section titled “Responses”Password changed, other sessions revoked
Invalid request
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Current credential rejected
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The Bearer challenge (RFC 6750).
The body is too large
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The body is not JSON
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”The media type the operation takes.
Too many requests
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}Headers
Section titled “Headers”Seconds to wait. Sent when the limit knows when it lifts.
The service failed
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}The service is at capacity
RFC 9457 problem details payload.
object
Explanation specific to this occurrence, written to help correct the request.
The invalid members of the request. Present on a validation problem.
One invalid member of a request, located by a JSON Pointer (RFC 6901).
object
What is wrong with it.
JSON Pointer to the member within the request body. Empty for the whole body.
HTTP status code.
Short summary of the problem type. For about:blank, the status phrase.
Problem type URI, which resolves to its documentation. Absent means about:blank.
Examplegenerated
{ "detail": "example", "errors": [ { "detail": "example", "pointer": "example" } ], "status": 1, "title": "example", "type": "example"}