Create mailbox credential
Creates an IMAP login password or generates a scoped API app password for a mailbox.
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
kind*"password""password"name?stringlength <= 128password*string8 <= length <= 1024scope?"full"A login password is always 'full'; any other value is refused
"full"username?string3 <= length <= 320Created credential (app_password secret is shown only once in this response)
application/json- response
id*stringCredential ULID
kind*"password"Standard password
"password"name*|Optional credential label
username*stringUsername or email address
curl -X POST 'https://api.open.email/api/v1/identities/string/credentials' \
-H 'Content-Type: application/json' \
-d '{
"kind": "password",
"password": "stringst"
}'{
"id": "string",
"kind": "password",
"name": "string",
"username": "string"
}Revoke an API key DELETE
Permanently revokes an API key. Where finished keys are retained for 180 days (see List API keys), an id in the form keys are minted in (26 upper-case…
List mailbox credentials GET
Returns every credential of a mailbox, revoked and expired ones included (secrets are never returned). Self-service: the mailbox's own bearer may read its own…