Skip to main content

Verify OTP SMS registration

POST 
/resources/v3alpha/users/:id/otp_sms/:otpSmsId/_verify

Verify the OTP SMS registration with the provided code.

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

    otpSmsId stringrequired

    unique identifier of the OTP SMS registration, which was returned in the add OTP SMS.

Query Parameters

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

Body

required

Set the verification code generated during the add OTP SMS request.

    string

    Possible values: non-empty and <= 200 characters

Responses​

OTP SMS authenticator 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...