POST /api/v1/users/{userId}/credentials/change_recovery_question
Updates a User's Recovery Question and answer credential by validating the User's current Password.
You can only perform this operation on Users in STAGED
, ACTIVE
, or RECOVERY
status that have a valid Password credential.
Servers
- https://{yourOktaDomain}
Path parameters
Name | Type | Required | Description |
---|---|---|---|
userId |
String | Yes |
ID of an existing Okta user |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
provider |
Object | No |
Specifies the authentication provider that validates the User's password credential. The User's current provider is managed by the Delegated Authentication settings for your organization. The provider object is read-only. |
provider.name |
String | No |
The name of the authentication provider |
provider.type |
String | No |
The type of authentication provider Possible values:
|
recovery_question |
Object | No |
Specifies a secret question and answer that's validated (case insensitive) when a User forgets their password or unlocks their account. The answer property is write-only. |
recovery_question.answer |
String | No |
The answer to the recovery question |
recovery_question.question |
String | No |
The recovery question |
password |
Object | No |
Specifies a password for a user. When a User has a valid password, imported hashed password, or password hook, and a response object contains
a password credential, then the password object is a bare object without the value property defined (for example, For information on defaults and configuring your password policies, see Configure the password authenticator in the help documentation. |
password.hash |
Object | No |
Specifies a hashed password to import into Okta. This allows an existing password to be imported into Okta directly
from some other store. Okta supports the BCRYPT, SHA-512, SHA-256, SHA-1, MD5, and PBKDF2 hash functions for password import.
A hashed password may be specified in a Password object when creating or updating a user, but not for other operations.
See Create User with Imported Hashed Password
for information on using this object when creating a user. When updating a User with a hashed password, the User must be in the |
password.hash.digestAlgorithm |
String | No |
Algorithm used to generate the key. Only required for the PBKDF2 algorithm. Possible values:
|
password.hash.keySize |
Integer | No |
Size of the derived key in bytes. Only required for PBKDF2 algorithm. |
password.hash.algorithm |
String | No |
The algorithm used to generate the hash using the password (and salt, when applicable). Possible values:
|
password.hash.iterationCount |
Integer | No |
The number of iterations used when hashing passwords using PBKDF2. Must be >= 4096. Only required for PBKDF2 algorithm. |
password.hash.value |
String | No |
For SHA-512, SHA-256, SHA-1, MD5, and PBKDF2, this is the actual base64-encoded hash of the password (and salt, if used).
This is the Base64-encoded |
password.hash.saltOrder |
String | No |
Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms. |
password.hash.workFactor |
Integer | No |
Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm. |
password.hash.salt |
String | No |
Only required for salted hashes. For BCRYPT, this specifies Radix-64 as the encoded salt used to generate the hash, which must be 22 characters long. For other salted hashes, this specifies the Base64-encoded salt used to generate the hash. |
password.hook |
Object | No |
Specify a password import inline hook to trigger verification of the User's password the first time the User signs in. This allows an existing password to be imported into Okta directly from some other store. |
password.hook.type |
String | No |
The type of password inline hook. Currently, must be set to default. |
password.value |
String | No |
Specifies the password for a user. The Password Policy validates this password. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.