Users API

User-directory reads for identifying the current request's user and listing candidate reviewers. These methods live on the system namespace at cms.api.users.<method> and mirror on the client as client.users.<method> with identical types. Both project the id plus the configured user.exposeColumns allowlist (password hashes and tokens are never selected), and both degrade when no user.table is configured: whoami returns { user: null } and listReviewers returns [].

Identify the Current User

Find out who the current request is authenticated as, so a client can learn its own identity without you supplying the id. You get back the user id plus the resolved user row (the configured exposeColumns). Both fields are null when unauthenticated, and user is null when no user.table is configured or the id matches no row.

const data = await cms.api.users.whoami();

const { data, error } = await client.users.whoami();

The resolved user is { id, ...exposeColumns } or null.

List Reviewers

List candidate reviewer users from your configured user.table — the picker source for approval workflows. Each user comes back as { id, ...exposeColumns }, ordered by id, and you get an empty list when no user.table is configured. All query fields are optional.

const data = await cms.api.users.listReviewers({
  query: { limit: 50 }, // all optional
});

const { data, error } = await client.users.listReviewers({
  query: { limit: 50 }, // all optional
});