Change mailbox login password
Updates the login password for a mailbox by verifying the existing password.
bearerAuthAuthorizationBearer <token>Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.
oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.
oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.
Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].
identityId*stringMailbox identity ULID
application/json- body
currentPassword*string1 <= length <= 1024newPassword*string8 <= length <= 1024Password updated successfully
application/json- response
changed*trueAlways true when password rotation succeeds
truecredentialId*stringThe credential ID whose password was rotated
curl -X PUT 'https://api.open.email/api/v1/identities/string/password' \
-H 'Content-Type: application/json' \
-d '{
"currentPassword": "string",
"newPassword": "stringst"
}'{
"changed": true,
"credentialId": "string"
}Invite a mailbox user to set their own password POST
Nominates an address as this mailbox's recovery address and mails it one code. If the mailbox has NO password credential the code sets the first password and…
Reset a mailbox password as an administrator POST
Sets a new password on every password credential the mailbox has, creating one if it has none (named after the primary address, or the group address for a…