List users

Retrieve a list of users in a 1Password EPM account. Use query parameters to filter by users state (active or suspended).

Method	Endpoint URL
GET	<base_url>/v1beta1/accounts/<account_id>/users

Make a request

Request headers

Include the following headers:

• Authorization: Bearer <YOUR_ACCESS_TOKEN>
• User-Agent: <CompanyOrProductName>/<version>

Path parameters

Name	Type	Required	Description
account_id	string	Yes	The unique identifier of the 1Password EPM account.

Query parameters

Name	Type	Required	Description
filter	string	No	Filter users by state. Supported values: user.isActive() user.isSuspended() Omit or leave empty to return both. Invalid values result in an InvalidArgument error.
max_page_size	integer	No	The maximum number of user records to return per page, up to 1000. The default setting is 25 if no maximum page size is specified.

Example requests

Retrieve a list of all users in a 1Password EPM account, with a query parameter to specify a maximum of 100 records per page:

Retrieve a list of all suspended users in a 1Password EPM account, with a maximum of 100 user records returned per page:

Fetch the next page of user records in the list using the next_page_token returned from a previous request. Include the token in the page_token query parameter:

Receive a response

A successful response returns 200 OK with a list of users (ListUsersResponse object) in the specified 1Password EPM account matching your query parameters (if any exist), along with a next_page_token if there are more pages of results to fetch.

Example response

Response schemas

ListUsersResponse object

Field	Type	Description
results	Array of User objects	List of users returned for this page.
next_page_token	string	Base64-encoded opaque token for fetching the next page of results, if available. The returned token can be used with the page_token query parameter.

User object

Field	Type	Description
id	string	User UUID.
email	string	User email address.
display_name	string	User display name.
state	string	User state. Possible values: STATE_UNSPECIFIED, ACTIVE, SUSPENDED.
create_time	string	Date and time when the user was created. Uses the RFC 3339 standard .
path	string	Resource path for the user. Format: accounts/<account_id>/users/<user_id>.