Administratively verify a user's email address. Use this method to bypass email verification for the user. The request body will contain the userId to be verified. An API key is required when sending the userId in the request body. OR Confirms a user's email address. The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The two values together are able to confirm a user's email address and mark the user's email address as verified.

post/api/user/verify-email

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/user/verify-email
  • Auth: API key in header Authorization

Request body

oneTimeCodestring
userIdstring uuid
verificationIdstring

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.