Suspend a user

Suspend a user. This action transitions the user's state from ACTIVE to SUSPENDED and suspends the user's access in the 1Password EPM account.

The :suspend action is idempotent. Using this action on a user who is already suspended returns the user with no changes to their state.

Method	Endpoint URL
POST	<base_url>/v1beta1/accounts/<account_id>/users/<user_id>:suspend

Restrictions

The following users can't be suspended from a 1Password EPM account:

• Externally managed administrators (EAM users).
• The last remaining owner of an account.

Your integration should handle these outcomes gracefully (for example: log the failure and notify an administrator).

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.
user_id	string	Yes	The unique identifier of the user.

Request body

This endpoint does not accept a request body.

Example request

Receive a response

A successful response returns 200 OK with the updated User object with the state set to SUSPENDED.

Example response

Response schemas

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. This value is SUSPENDED for a successful response.
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>.