PUT
/
admin
/
users
/
{userId}
Update user details
curl --request PUT \
  --url https://{tenant}/admin/users/{userId} \
  --header 'Admin-Auth: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "access_key": "c8251902f3f44dfa729e0267d0d62859",
  "active": false,
  "email_address": "itachisasuke@gmail.com",
  "first_name": "itachi",
  "id": "679a02465715ecdd507d7273",
  "last_name": "sasuke",
  "org_id": ""
}'
{
  "Message": "c8251902f3f44dfa729e0267d0d62859",
  "Meta": {
    "access_key": "c8251902f3f44dfa729e0267d0d62859",
    "active": false,
    "api_model": {},
    "created_at": "2025-03-10T11:10:52.986309+03:00",
    "email_address": "itachisasuke@gmail.com",
    "first_name": "itachi",
    "group_id": "",
    "id": "363739613032343635373135656364643530376437323733",
    "last_login_date": "0001-01-01T00:00:00Z",
    "last_name": "sasuke",
    "org_id": "",
    "password_max_days": 0,
    "password_updated": "0001-01-01T00:00:00Z",
    "user_permissions": {
      "IsAdmin": "admin",
      "ResetPassword": "admin"
    }
  },
  "Status": "OK"
}

Authorizations

​
Admin-Auth
string
header
required

Api key

Path Parameters

​
userId
string
required

The Id of the user you want to update

Body

application/json
​
access_key
string
​
active
boolean
​
api_model
object
​
email_address
string
​
first_name
string
​
group_id
string
​
id
string
​
last_login_date
string<date-time>
​
last_name
string
​
org_id
string
​
password_max_days
integer
​
password_updated
string<date-time>
​
user_permissions
object

Response

User updated successfully

​
ID
string
​
Message
string
​
Meta
any
​
Status
string