Resend the e-mail verification message

POST

/api/v1/users/{id}/resend-verification

const url = 'http://localhost:3000/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resend-verification';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resend-verification \
  --header 'X-API-Key: <X-API-Key>'

Asks Keycloak to re-send the verification e-mail for a user whose address is not yet verified. Returns 400 when the address is already verified, because sending would imply the account is blocked when it is not.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

User UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

application/json

object

sent

required

Whether Keycloak accepted the request to send the message. False means the user is still flagged to verify at next sign-in, but no e-mail was delivered.

boolean

email

required

The address the message was sent to.

string

error

Why the send failed, when it did. Absent on success.

string

Example

{
  "sent": true,
  "email": "user@example.com",
  "error": "SMTP server not configured for this realm"
}

400

The address is already verified

401

Unauthorized

404

User not found, not a member of the active organization, or has no Keycloak account