Users REST API

List all users. The user must be an admin on the server to use this route. The HTTP response header `X-Total-Count` contains the total number of users.

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Query Parameters

The direction to sort by. If not specified, the default sort direction is used.

Default: asc

One of: asc, desc

The page number to return. If not specified, the first page is returned.

Default: 1

The number of items to return per page. If not specified, the default number of items per page (8) is used.

Default: 8

The field to sort by. If not specified, the default sort field is used.

Default: name

One of: name

Filter by user name, exact match.

Search by user name, slug, or UUID.

View a user. Only the authenticated user themselves and server admins have access to this endpoint. To view users within your organization, use the organization members endpoints.

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Path Parameters

The slug or UUID for a user.

Update a user. Only the authenticated user themselves and server admins have access to this endpoint. Some fields can only be updated by an admin. Changing the email, admin, or locked field requires a user session, even for an admin: neither a user API key nor a deprecated user API token can change them. A user's new email for themselves takes effect only once it is confirmed from a link sent to that email, so until then the response shows the current email. Any later update to the user ends that link. A server admin's change to another user's email takes effect at once. To manage users within your organization, use the organization members endpoints.

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Path Parameters

The slug or UUID for a user.

Body Parameters

Update whether the user is an admin. Must be an admin to update this field.

The new email for the user. A user's new email for themselves takes effect once it is confirmed from a link sent to it. A server admin's change to another user's email takes effect at once.

Update whether the user is locked. Must be an admin to update this field.

The new name of the user. Maximum length is 64 characters. May only contain alphanumeric characters, non-leading or trailing spaces, and the following characters: , . - '

The preferred new slug for the user. Maximum length is 64 characters.

Change a user's email to the new email that a confirm link was sent to. A user who updates their own email is sent that link at the new email, and its token lasts as long as a login link's. No credential is needed, so the link works from any device. Any later update to the user ends the link, this confirm included. The response holds a new session for the new email. An invalid or expired token is refused with `401 Unauthorized`; a token for another user, or one sent before the user's latest update, with `403 Forbidden`; and a new email that another user has taken since with `409 Conflict`.

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Path Parameters

The slug or UUID for a user.

Body Parameters