Sign in
Authentication Self Admin

Complete FIDO token registration for the current user.

post/api/web/v1/self/fidotokens

Request

  • Base URL: https://customer.region.trustedauth.com
  • URL: https://customer.region.trustedauth.com/api/web/v1/self/fidotokens
  • Auth: API key in header Authorization

Request body

attestationObjectstring

The FIDO attestationObject data returned from the FIDO token. This is a base-64 encoded value.

clientDataJSONstring

The FIDO clientData returned from the FIDO token. This is a base-64 encoded value.

namestring

Optional display name for the new FIDO token. If omitted or blank, the server auto-generates one from the authenticator model (DIRECT/INDIRECT attestation) or defaults to 'Passkey' (NONE attestation).

rpIdstring

Specifies the domain name (relying party ID) of your application and the passkey is registered with. Provide the domain only (e.g., example.com), without protocol (https://). Required if using a custom domain different from your IDaaS tenant's hostname.

transportsstring[]

The transport methods used during registration (e.g., 'usb', 'nfc', 'ble', 'internal'). Used to determine authenticator capabilities.

userIdStoredboolean

Flag indicating if the userId was stored on the registered FIDO2 token. Defaults to false if not set.

Example request

{
  "rpId": "mycompany.example.com"
}

Response

Successful

aaguidstring

The AAGUID of the authenticator that created this FIDO token.

aaguidVerifiedboolean

Indicates whether the AAGUID reported by the authenticator was cryptographically verified via a full certificate chain against the FIDO MDS trust anchors. True only for DIRECT attestation; false for INDIRECT (cert chain not verified); null for NONE (no attestation collected).

algorithmstring

The signature algorithm of the authenticator that created this FIDO token.

allowedActionsstring[]

Administration actions that can be performed on this FIDO token.

attestationFormatstring

Attestation format of the authenticator that created this FIDO token.

attestedDataboolean

Indicates if this FIDO token contains attested data.

authenticatorModelstring

The authenticator model of the authenticator that created this FIDO token.

backupEligibleboolean

Indicates if this FIDO token is eligible for backup.

backupStatusboolean

Indicates if this FIDO token is currently backed up.

createDatestring date-time

The date on which the FIDO token was created.

iconstring

The icon of the authenticator that created this FIDO token.

idstring

The unique UUID assigned to the fido token when it is registered.

lastUsedDatestring date-time

The date on which this FIDO token was last used for authentication. This value will be null if the FIDO token has never been used.

namestring

The name of this FIDO token.

originstring

The origin of where the FIDO token was generated.

relyingPartyIdstring

The relying party ID of where the FIDO token was generated.

state'ACTIVE' | 'INACTIVE'

The state of this FIDO token. Only FIDO tokens in the ACTIVE state can be used for authentication.

userIdstring

The user Id of the user who owns this FIDO token.

userIdStoredboolean

Indicates if the userId was stored on the FIDO token.

userPresentboolean

Indicates if the user was present during the registration or authentication ceremony that created or last used this FIDO token.

userUUIDstring

The UUID of the user who owns this FIDO token.

userVerifiedboolean

Indicates if the user was verified during the registration or authentication ceremony that created or last used this FIDO token.

Example response

{
  "createDate": "2019-02-19T13:15:27Z",
  "lastUsedDate": "2019-02-21T11:37:27Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.