Skip to main content

Add One-Time Password (OTP)

POST 
https://$CUSTOM-DOMAIN/auth/v1/users/me/auth_factors/otp

Add a new One-Time Password (OTP) factor to the authenticated user. OTP is an authenticator app like Google/Microsoft Authenticator, Authy, etc. Only one OTP per user is allowed. After adding a new OTP it has to be verified.

Request​

Body

required

    object

Responses​

A successful response.

Schema

    url string
    secret string

    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

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: 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

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L 'https://$CUSTOM-DOMAIN/auth/v1/users/me/auth_factors/otp' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/auth/v1
Auth
Body required
{}
ResponseClear

Click the Send API Request button above and see the response here!