Documentation Index Fetch the complete documentation index at: https://www.1password.dev/llms.txt
Use this file to discover all available pages before exploring further.
Suspend a user. This action transitions the user’s state from ACTIVE to SUSPENDED and suspends the user’s access in the 1Password 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 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 Include the following headers:
Authorization: Bearer <YOUR_ACCESS_TOKEN>User-Agent: <CompanyOrProductName>/<version>
Path parameters Name Type Required Description account_idstring Yes The unique identifier of the 1Password account. user_idstring Yes The unique identifier of the user.
Request body This endpoint does not accept a request body.
Example request curl --request POST \ --url "https://api.1password.com/v1beta1/accounts/<account_id>/users/<user_id>:suspend" \ --header "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \ --header "User-Agent: <CompanyOrProductName>/<version>"
Receive a response A successful response returns 200 OK with the updated User object with the state set to SUSPENDED.
Example response { "id" : "IR7VJHJ36JHINBFAD7V2T5MP3E" , "email" : "wendy_appleseed@agilebits.com" , "display_name" : "Wendy Appleseed" , "state" : "SUSPENDED" , "create_time" : "2024-01-15T10:30:00Z" , "path" : "accounts/ACCOUNT123/users/IR7VJHJ36JHINBFAD7V2T5MP3E" }
Response schemas User object Field Type Description idstring User UUID. emailstring User email address. display_namestring User display name. statestring User state. Possible values: STATE_UNSPECIFIED, ACTIVE, SUSPENDED. This value is SUSPENDED for a successful response. create_timestring Date and time when the user was created. Uses the RFC 3339 standard . pathstring Resource path for the user. Format: accounts/<account_id>/users/<user_id>.
