Skip to main content

Start FIDO token registration

GET 
/api/web/v1/fidotokens/challenge/:id

Start FIDO token registration for the specified user. Caller requires the FIDOTOKENS:ADD permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the user for which the fido token is to be created.

Responses​

Successful

Schema

    challenge string

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

    registeredCredentials string[]

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

    registrationAuthenticatorAttachment string

    Possible values: [EITHER, PLATFORM, CROSS_PLATFORM]

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

    registrationRequireResidentKey string

    Possible values: [DISCOURAGED, PREFERRED, REQUIRED]

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

    registrationUserVerification string

    Possible values: [DISCOURAGED, PREFERRED, REQUIRED]

    Should the token perform user verification?

    rpName string

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

    timeout int32

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

    userDisplayName string

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

    userId string

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

    userName string

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

Loading...