Updating Users

This step shows how to update Perculus users.

Below is a list of available parameters for updating users:

Parameter	Type	Description
name	string	Name of the user
surname	string	Surname of the user
email	string	Email of the user
username	string	Username of the user
role	string	Role of the user(see)
psd	string	Password of the user
mobile	string	Mobile of the user
login_allowed	bool	Flag if the login is allowed
active	bool	Flag if the user is active
lang	string	Language of the user(see). This option modifies: session interface, panel interface and mails.
timezone	string	Timezone of the user(see) This option modifies: how the user sees sessions' hours.
expires_at	string	Date which the user will expire(see)

If a parameter is not sent or if its null, it won't be applied. So if you only want to update the field email for a user, you don't have to send other parameters.

A request like so would achieve that:

curl --location --request PUT 'https://<DOMAIN>/xapi/user/<USER_ID>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "role": "a"
}'

Example payload:

CURL

curl --location --request PUT 'https://<DOMAIN>/xapi/user/<USER_ID>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "John1",
    "surname": "Doe1",
    "username": "johndoe1",
    "email": "[e-mail]1"
}'

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Update user 
user = client.users.update_user("<USER_ID>",{
    "name": "john1",
    "surname": "Doe1",
    "username": "johndoe1",
    "email": "[e-mail]1"
})
print(user)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Update user 
const user = client.users.updateUser("<USER_ID>", {
    name: "<USER_NAME>",
    surname: "<USER_SURNAME>",
    username: "<USERNAME>",
    email: "<USER_EMAIL>",
    role: "<USER_ROLE>"
})
console.log(user)

Go

// ASAP :)

Example response:

{
    "user_id": "<USER_ID>",
    "name": "john1",
    "surname": "Doe1",
    "username": "johndoe1",
    "email": "[e-mail]1",
    "role": "u",
    "mobile": "",
    "login_allowed": true,
    "status": 1,
    "lang": "tr-TR",
    "timezone": null,
    "expires_at": null,
    "creation_date": "2024-08-01T00:45:03.8888474+00:00",
    "updating_date": null
}