# auth.whoami

Get current authenticated identity.

Answers what the presented bearer credential IS and therefore what it reaches; call it first when integrating. Key on `type`: `account` (an `oek_…` API key: the account's directory plus every mailbox it owns), `mailbox` (an `oemp_…` app password: one mailbox, `mailboxId` says which; directory routes answer 403 insufficient_scope), or `system` (an operator key). `scope` and `permittedRecipients` are a mailbox credential's own bound (D50): what it may do, and who it may send to — asked once here rather than learned from a 403 per call. `idleExpiresAt` warns when a key will lapse from disuse, so a client can say 'this key stops working on \<date> unless you use it' rather than letting the holder discover it as a 401.

```ts
openemail.auth.whoami(options?: CallOptions): ApiPromise<WhoamiResult>
```

It calls `GET /auth/whoami`: [Get current authenticated identity](/docs/api/credentials/get_AuthWhoami) in the API reference.

## Example

```ts
const whoamiResult = await openemail.auth.whoami()
```

## 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, [`WhoamiResult`](/docs/sdks/typescript/types/whoami-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 |
| `503` | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

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: [`WhoamiResult`](/docs/sdks/typescript/types/whoami-result).
