POST /webauthn-registration/api/v1/activate
Activates a preregistered WebAuthn factor. As part of this operation, Okta first decrypts and verifies the factor PIN and enrollment data sent by the fulfillment provider.
Servers
- https://{yourOktaDomain}
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 |
|---|---|---|---|
userId |
String | No |
ID of an existing Okta user |
pinResponseJwe |
String | No |
Encrypted JWE of the PIN response from the fulfillment provider |
credResponses[] |
Array | No |
List of credential responses from the fulfillment provider |
credResponses[].credResponseJwe |
String | No |
Encrypted JSON Web Encryption (JWE) of the credential response from the fulfillment provider |
credResponses[].authenticatorEnrollmentId |
String | No |
ID for a WebAuthn preregistration factor in Okta |
version |
String | No |
Firmware version of the YubiKey |
serial |
String | No |
Serial number of the YubiKey |
yubicoSigningJwks[] |
Array | No |
List of usable signing keys from Yubico (in JSON Web Key Sets (JWKS) format). The signing keys are used to verify the JSON Web Signature (JWS) inside the JWE. |
yubicoSigningJwks[].kty |
String | Yes |
The type of public key Valid values:
|
yubicoSigningJwks[].kid |
String | Yes |
The unique identifier of the key |
yubicoSigningJwks[].crv |
String | Yes |
The elliptic curve protocol Valid values:
|
yubicoSigningJwks[].use |
String | Yes |
The intended use for the key. This value is either Valid values:
|
yubicoSigningJwks[].x |
String | Yes |
The public x coordinate for the elliptic curve point |
yubicoSigningJwks[].y |
String | Yes |
The public y coordinate for the elliptic curve point |
fulfillmentProvider |
String | No |
Name of the fulfillment provider for the WebAuthn preregistration factor Valid values:
|
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.