Skip to Content

Revoke a mailbox credential.

Revokes an existing password or app password, closing its active sessions. Self-service: the mailbox's own bearer may revoke its own APP passwords (a login password answers 404 to it, exactly like a missing id).

openemail.credentials.revoke(
  identityId: string,
  credentialId: string,
  options?: CallOptions,
): ApiPromise<RevokedResult>

It calls DELETE /identities/{identityId}/credentials/{credentialId}: Revoke a mailbox credential in the API reference.

Example

const revokedResult = await openemail.credentials.revoke(identityId, credentialId)

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
credentialIdstringCredential ULID identifier. The path's {credentialId}.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, RevokedResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox or credential not found
503temporary_failure (with Retry-After): under the object directory, the account's identity census could not be updated just now, so the write that would move it was not made; retry the same request after the Retry-After window (a revocation that would take push subscriptions with it)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: RevokedResult.