Sign in
Authentication Self Admin

Start FIDO token registration for the current user.

get/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

Response

Successful

attestation'NONE' | 'INDIRECT' | 'DIRECT'

Attestation preference for passkey/FIDO2 registration. Determines how much information about the authenticator (security key/passkey) is shared during registration. NONE: No authenticator details shared (recommended for privacy). INDIRECT: Basic information shared in a privacy-preserving way (balanced approach). DIRECT: Full authenticator details shared (use when you need to verify specific device models).

challengestring

The registration challenge generated by Identity as a Service. This is a base-64 encoded value.

registeredCredentialsstring[]

The IDs of FIDO tokens already registered to this user. These values are base-64 encoded.

registeredCredentialsNamesstring[]

The names of FIDO tokens already registered to this user.

registrationAuthenticatorAttachment'EITHER' | 'PLATFORM' | 'CROSS_PLATFORM'

Should the token be embedded on the device or stored externally?

registrationRequireResidentKey'DISCOURAGED' | 'PREFERRED' | 'REQUIRED'

Should the User ID be stored on the Passkey/FIDO2 token?

registrationUserVerification'DISCOURAGED' | 'PREFERRED' | 'REQUIRED'

Should the token perform user verification?

rpNamestring

The name of this relying party. This is the name of the Identity as a Service account.

timeoutinteger

The number of seconds that the client will wait for the FIDO token to respond. This field is deprecated, use 'timeoutMillis' instead.

timeoutMillisinteger

The time in milliseconds that the client will wait for the FIDO token to respond.

userDisplayNamestring

The display name of this user. It will be 'firstname lastname' of the user

userIdstring

The id of this user. It will be UUID of the user base-64 encoded.

userNamestring

The name of this user. It will be the userId of the user.

Changes

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