Skip to main content

Add a OTP Email authenticator​

Add a new one-time-password (OTP) Email authenticator to a user. If the email is not passed as verified, a verification code will be generated, which can be either returned or will be sent to the user by email.

Path Parameters
    userId string required

    unique identifier of the user.

Request Body required
    email object

    Set the user's email for the OTP Email authenticator and it's verification state.

    address string required

    Possible values: non-empty and <= 200 characters

    Set the email address.

    sendCode object

    Let ZITADEL send the link to the user via email.

    urlTemplate string

    Possible values: non-empty and <= 200 characters

    Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

    returnCode object

    Get the code back to provide it to the user in your preferred mechanism.

    isVerified boolean

    Set the email as already verified.

Responses

OTP Email authenticator successfully added

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
    otpEmailId string

    unique identifier of the OTP Email registration.

    verificationCode string

    The OTP verification code will be set if a email was set with a return_code verification option.

POST /v3alpha/users/:userId/otp_email

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
userId — path required
Content-Type
Body required
{

  "email": {

    "address": "mini@mouse.com",

    "sendCode": {

      "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"

    },

    "returnCode": {},

    "isVerified": true

  }

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/otp_email' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email": {
    "address": "mini@mouse.com",
    "sendCode": {
      "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
    },
    "returnCode": {},
    "isVerified": true
  }
}'