Skip to main content

Start a TOTP registration

POST 
/resources/v3alpha/users/:id/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

    id stringrequired

    unique identifier of the user.

Query Parameters

    instance.id string
    instance.domain string
    organization.orgId string
    organization.orgDomain string

Responses​

TOTP registration successfully started

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

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