Skip to content

Init hosted registration

Request

Initializes a hosted WebAuthn registration flow for a logged-out user (see Quickstart). This API is used to securely set the WebAuthn username in the backend, and returns a registration token used to start the registration flow. Relevant only for hosted login scenarios

Security
ClientAccessToken
Bodyapplication/jsonrequired
webauthn_identifierstring, [ 1 .. 64 ] charactersrequired

Account name for this Relying Party. This is used both for display purposes, as well as during recovery flows where the user is asked for the account name.

webauthn_display_namestring, [ 1 .. 64 ] characters

Human-palatable name for the user account, only for display (max 64 characters). If not set, the username parameter will also act as the display name

external_user_idstring, [ 1 .. 64 ] characters

A unique identifier in the tenant, which corresponds to an identifier of the user in your system.

redirect_uristringrequired

URI to redirect to upon completing the registration process

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/webauthn/external/register/hosted/hint \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webauthn_identifier": "string",
    "webauthn_display_name": "string",
    "external_user_id": "string",
    "redirect_uri": "string"
  }'

Responses

Registered credential details

Bodyapplication/json
register_webauthn_cred_tokenstringrequired

Token returned to relying party to ensure the specified username is being used for webauthn credential registration

Response
{ "register_webauthn_cred_token": "string" }