credentials.list
List mailbox credentials.
Returns every credential of a mailbox, revoked and expired ones included (secrets are never returned). Self-service: the mailbox's own bearer may read its own list.
openemail.credentials.list(
identityId: string,
options?: CallOptions,
): ApiPromise<CredentialsListResult>It calls GET /identities/{identityId}/credentials: List mailbox credentials in the API reference.
Example
const result = await openemail.credentials.list(identityId)Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Mailbox identity ULID. The path's {identityId}. |
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, CredentialsListResult. It is an ApiPromise: .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 not found or not accessible to this principal |
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: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
CredentialsListResult
/** What `credentials.list` answers. */
type CredentialsListResult = {
credentials: Credential[]
}It names these types of the API, each on a page of its own: Credential.