Skip to main content
POST
/
users
/
{userId}
/
deactivate
Deactivate a user
curl --request POST \
  --url https://api.eu.bronto.io/users/{userId}/deactivate \
  --header 'X-BRONTO-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@company.com",
  "roles": [
    "ReadOnly",
    "Standard"
  ],
  "last_logins": {
    "Okta": 1731370728,
    "Password": 1731338939
  },
  "login_methods": [
    {
      "name": "Password",
      "enabled": true
    }
  ],
  "tags": {
    "region": "eu",
    "environment": "production"
  },
  "status": "INVITED",
  "invited_at": 1731370728,
  "invited_by": "admin@company.com"
}

Authorizations

​
X-BRONTO-API-KEY
string
header
required

Path Parameters

​
userId
string<uuid>
required

Unique identifier of the user to deactivate

Response

User deactivated successfully

​
id
string<uuid>
required

The unique identifier for the user

​
first_name
string
required

The user's first name

Example:

"John"

​
last_name
string
required

The user's last name

Example:

"Doe"

​
email
string<email>
required

The user's email address

Example:

"john@company.com"

​
roles
string[]

A list of role ids

Example:
["ReadOnly", "Standard"]
​
last_logins
object

A map of login methods to their last login timestamps (Unix epoch).

Example:
{
  "Okta": 1731370728,
  "Password": 1731338939
}
​
login_methods
object[]
​
tags
object

A map of key value pairs associated with this log

Example:
{
  "region": "eu",
  "environment": "production"
}
​
status
enum<string>

Current status of the user

Available options:
INVITED,
ACTIVE,
INACTIVE,
DEACTIVATED,
MIGRATED,
REMOVED
​
invited_at
integer<int64>

Unix timestamp (seconds) of the last invitation sent to the user

Example:

1731370728

​
invited_by
string

Identifier for the user who sent the latest invitation

Example:

"admin@company.com"