Skip to main content

Start a TOTP registration

POST 
/v3alpha/users/:userId/totp

Start the registration of a new time-based one-time-password (TOTP) generator for a user. As a response a secret is returned, which is used to initialize a TOTP app or device.

Request​

Path Parameters

    userId stringrequired

    unique identifier of the user.

Responses​

TOTP registration successfully started

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)
    totpId string

    unique identifier of the TOTP registration.

    uri string

    The TOTP URI, which can be used to create a QR Code for scanning with an authenticator app.

    secret string

    The TOTP secret, which can be used for manually adding in an authenticator app.

Loading...