POST /api/v1/org/factors/yubikey_token/tokens

Uploads a seed for a user to enroll a YubiKey OTP

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
sortOrder String No

Specifies the sort order, either ASC or DESC

Possible values:

  • "DESC"
  • "ASC"
forDownload Boolean No

Returns tokens in a CSV to download instead of in the response. When you use this query parameter, the limit default changes to 1000.

Default value: false

limit Integer No

Specifies the number of results per page

Default value: 20

filter String No

The expression used to filter tokens

Possible values:

  • "profile.serial"
  • "created"
  • "user.id"
  • "lastVerified"
  • "profile.email"
  • "activated"
  • "status"
sortBy String No

The value of how the tokens are sorted

Possible values:

  • "profile.serial"
  • "created"
  • "user.id"
  • "lastVerified"
  • "profile.email"
  • "activated"
  • "status"
after String No

Specifies the pagination cursor for the next page of tokens

expand String No

Embeds the User resource if the YubiKey Token is assigned to a user and expand is set to user

Request body fields

Name Type Required Description
publicId String No

The Yubikey's public ID

serialNumber String No

The unique identifier assigned to each YubiKey device

privateId String No

The Yubikey's private ID

aesKey String No

The cryptographic key used in the AES algorithm to encrypt and decrypt YubiKey OTP

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.