Skip to main content

Verify a TOTP registration

POST 
/resources/v3alpha/users/:id/totp/:totpId/_verify

Verify the time-based one-time password (TOTP) registration with the generated code.

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

    totpId stringrequired

    unique identifier of the TOTP registration, which was returned in the start TOTP registration.

Query Parameters

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

Body

required

Code generated by TOTP app or device.

    string

    Possible values: >= 6 characters and <= 9 characters

Responses​

TOTP registration successfully verified

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