# credentials.revoke

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).

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

It calls `DELETE /identities/{identityId}/credentials/{credentialId}`: [Revoke a mailbox credential](/docs/api/credentials/delete_CredentialDelete) in the API reference.

## Example

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

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `identityId` | `string` | Mailbox identity ULID. The path's `{identityId}`. |
| `credentialId` | `string` | Credential 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](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`RevokedResult`](/docs/sdks/typescript/types/revoked-result). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox or credential not found |
| `503` | temporary_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`](/docs/sdks/typescript/errors): 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`](/docs/sdks/typescript/types/revoked-result).
