identities.listClients
List an identity's clients.
Where this identity has been reached from: one row per (protocol, network, credential), newest first, up to 200 tuples over the last 30 days. Self-service: the identity's own credential may read its own list — under the same full-scope rule as the credential list, because the rows name every other credential and the networks it is used from, which a leaked read-scoped token must not learn. A null country means nobody looked, not an unknown location; mail-protocol rows carry null until the fleet resolves locations.
openemail.identities.listClients(
identityId: string,
options?: IdentitiesListClientsOptions,
): PagePromise<IdentitiesListClientsResult, IdentityClient>It calls GET /identities/{identityId}/clients: List an identity's clients in the API reference.
Example
for await (const identityClient of openemail.identities.listClients(identityId)) {
// every item of every page (await the call instead for one page)
}Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Identity ULID. The path's {identityId}. |
Options
The last argument, options, a IdentitiesListClientsOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
limit | number | query limit | Page size (default 100) |
cursor | string | query cursor | Opaque page cursor from a previous response |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
It is a listing, a PagePromise. Awaited, it is one page as the API answers it, IdentitiesListClientsResult. Iterated with for await, it is every IdentityClient of every page, each page fetched as the loop reaches it.
Errors
| Status | What it means |
|---|---|
400 | validation_failed, or invalid_cursor for a cursor that is not one this list issued |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
403 | credential_scope: the credential is scoped below full |
404 | Identity 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
IdentitiesListClientsResult
/** What `identities.listClients` answers. */
type IdentitiesListClientsResult = {
clients: IdentityClient[]
/** Opaque cursor for the next page; absent on the last page */
nextCursor?: string
}It names these types of the API, each on a page of its own: IdentityClient.