Skip to main content

Complete FIDO token registration

POST 

/api/web/v1/fidotokens/complete/:id

Complete 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.

Body

required

    attestationObject string

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

    clientDataJSON string

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

    name string

    The name for the new FIDO token.

    userIdStored boolean

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

Responses

Successful

Schema

    allowedActions string[]

    Possible values: [DELETE, ENABLE, DISABLE, RENAME]

    Administration actions that can be performed on this FIDO token.

    createDate date-time

    The date on which the FIDO token was created.

    id string

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

    lastUsedDate 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.

    name string

    The name of this FIDO token.

    origin string

    The origin of where the FIDO token was generated.

    relyingPartyId string

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

    state string

    Possible values: [ACTIVE, INACTIVE]

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

    userId string

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

    userIdStored boolean

    Indicates if the userId was stored on the FIDO token.

    userUUID string

    The UUID of the user who owns this FIDO token.

Loading...