POST /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate
Activates a Factor. Some Factors (call, email, push, sms, token:software:totp, u2f, and webauthn) require activation to complete the enrollment process.
Okta enforces a rate limit of five activation attempts within five minutes. After a user exceeds the rate limit, Okta returns an error message.
Note: If the user exceeds their SMS, call, or email factor activate rate limit, then an OTP resend request (
/api/v1/users/${userId}}/factors/${factorId}/resend) isn't allowed for the same Factor.
Servers
- https://{yourOktaDomain}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
ID of an existing Okta user |
factorId |
String | Yes |
ID of an existing user Factor |
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 |
|---|---|---|---|
passCode |
String | No |
OTP for the current time window |
attestation |
String | No |
Base64-encoded attestation from the WebAuthn authenticator |
clientData |
String | No |
Base64-encoded client data from the WebAuthn authenticator |
registrationData |
String | No |
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.