Skip to Content

The CredentialCreatedAppPassword type of the TypeScript SDK, part of CredentialCreated.

type CredentialCreatedAppPassword = {
  expiresAt: number | null
  id: string
  kind: 'app_password'
  name: string | null
  permittedRecipients: string[] | null
  scope: ('read' | 'write' | 'send' | 'full')
  token: string
  username: string
}

Fields

FieldTypeDescription
expiresAtnumber | nullExpiration timestamp in epoch seconds, or null for no expiry
idstringCredential ULID
kind'app_password'App-specific password
namestring | nullOptional credential label
permittedRecipientsstring[] | nullThe credential's OWN outbound recipient allowlist (exact addresses or *@domain), intersected with the identity's: both must permit. null = none of its own. Only a 'send' credential carries one
scope('read' | 'write' | 'send' | 'full')The credential's scope, a ladder: 'read' (list and read mail — nothing that leaves a trace), 'write' (also mark, file, label and trash — everything the store can undo), 'send' (also submit mail), 'full' (also permanent deletion, every settings and credential route, PIM collection lifecycle and sharing — the human's own session, and the default)
tokenstringPlaintext app password secret (returned once only at creation)
usernamestringUsername or email address

Used in

CredentialCreated.

On this page