/api/admin/users/{uid}/email-logAdminList the verification, password reset and MFA alert e-mails sent to a user
Lists the most recent 100 attempts to e-mail the user a verification link, a password reset link or an MFA security alert (MFA enabled, a factor removed, an administrator's MFA reset, recovery codes regenerated), newest first, including attempts the mail server did not accept.
get_api_admin_users_uid_email_logAdministrationAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Platform administrators only
Path parameters
| Name | Type | Description |
|---|---|---|
| uid* | string (uuid) | uid of the target user |
Responses
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| data* | object | |
| entries* | AdminUserEmailLogEntry[] | |
| email_log_id* | string | |
| uid* | string | |
| email_type* | "email_verification" | "password_reset" | "mfa_enabled_alert" | "mfa_removed_alert" | "mfa_admin_reset_alert" | "mfa_recovery_codes_regenerated_alert" | Which e-mail was sent |
| source* | "registration" | "user_request" | "admin_request" | What triggered it: the verification e-mail sent at sign-up, something the user did (a request, or an MFA change for the MFA alerts), or an administrator's action (a verification resend, an MFA reset) |
| recipient* | string | Address the e-mail was sent to, as it was at the time |
| status* | "sent" | "failed" | Whether the mail server accepted the e-mail |
| failure_reason* | string | null | null | Why a failed attempt failed; null for sent e-mails |
| requested_by* | string | null | null | uid of the administrator behind an |
| requested_by_email* | string | null | null | Current e-mail address of the |
| created_at* | number | Unix epoch milliseconds |
Example request
curl -X GET 'https://auth.schemavaults.com/api/admin/users/<uid>/email-log' \
-b 'refresh_token_<auth_server_app_id>=<value>'