Skip to Content
POST
/api/v1/identities/{identityId}/credentials

Creates an IMAP login password or generates a scoped API app password for a mailbox.

Authorization

bearerAuth
headerAuthorizationBearer <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: [].

Path Parameters

identityId*string

Mailbox identity ULID

Request Body

application/json
  1. body
kind*"password"
Value in"password"
name?string
Lengthlength <= 128
password*string
Length8 <= length <= 1024
scope?"full"

A login password is always 'full'; any other value is refused

Value in"full"
username?string
Length3 <= length <= 320

Response Body

Created credential (app_password secret is shown only once in this response)

application/json
  1. response
id*string

Credential ULID

kind*"password"

Standard password

Value in"password"
name*|

Optional credential label

username*string

Username or email address

Example Request
curl -X POST 'https://api.open.email/api/v1/identities/string/credentials' \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "password",
  "password": "stringst"
}'
Example Response
{
  "id": "string",
  "kind": "password",
  "name": "string",
  "username": "string"
}