The MyAccount Password API provides operations to enroll, update, and delete passwords.
Note: Super admins can enable the IDP MyAccount API Password feature. See Manage Early Access and Beta features.
A valid API version in the Accept header is required to access the API. Current version: 1.0.0
Accept: application/json; okta-version=1.0.0
okta.myAccount.password.readRetrieves the current user's password status
Note: This request only returns information about the password, not the password itself.
Example response
Unauthorized
{- "id": "00T196qTp3LIMZQ0L0g3",
- "status": "ACTIVE",
- "created": "2020-01-14T20:05:32.000Z",
- "lastUpdated": "2020-01-14T20:05:32.000Z",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "DELETE",
- "PUT"
]
}
}
}
}okta.myAccount.password.manageCreates and enrolls a password for the current user
Example response
Bad Request
Unauthorized
Conflict
{- "profile": {
- "password": "Abcd1234"
}
}{- "id": "00T196qTp3LIMZQ0L0g3",
- "status": "ACTIVE",
- "created": "2020-01-14T20:05:32.000Z",
- "lastUpdated": "2020-01-14T20:05:32.000Z",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "DELETE",
- "PUT"
]
}
}
}
}okta.myAccount.password.manageReplaces the password for the current user
Example response
Bad Request
Unauthorized
Forbidden
{- "profile": {
- "password": "Abcd1234"
}
}{- "id": "00T196qTp3LIMZQ0L0g3",
- "status": "ACTIVE",
- "created": "2020-01-14T20:05:32.000Z",
- "lastUpdated": "2020-01-14T20:05:32.000Z",
- "_links": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "DELETE",
- "PUT"
]
}
}
}
}okta.myAccount.password.manageDeletes the current user's enrolled password
No Content
Unauthorized
Not Found
{- "errorCode": "E0000015",
- "errorSummary": "You do not have permission to access the feature you are requesting",
- "errorLink": "E0000015",
- "errorId": "oaeStOuPPxDRUm3PJhf-tL7bQ",
- "errorCauses": [ ]
}