Skip to main content

Create a WebAuthN registration link

POST 
/v3alpha/users/:userId/webauthn/registration_link

Create a link, which includes a code, that can either be returned or directly sent to the user. The code will allow the user to start a new WebAuthN registration.

Request​

Path Parameters

    userId stringrequired

    unique identifier of the user.

Body

required

    sendLink

    object

    Let ZITADEL send the link to the user via email.

    urlTemplate string

    Possible values: non-empty and <= 200 characters

    Optionally set a url_template, which will be used in the mail sent by ZITADEL to guide the user to your passkey registration page. If no template is set, the default ZITADEL url will be used.

    returnCode object

    Get the code back to provide it to the user in your preferred mechanism.

Responses​

WebAuthN registration successfully created

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

    code

    object

    In case the medium was set to return_code, the code will be returned.

    id stringrequired

    Possible values: non-empty and <= 200 characters

    ID to the one time code generated by ZITADEL.

    code stringrequired

    Possible values: non-empty and <= 200 characters

    one time code generated by ZITADEL.

Loading...