Edit user

This endpoint allows to edit a user, this is also the endpoint used to assign a tag if it was not done when a user was added. Note that you cannot edit the name or email of a user if the user has completed the sign up for Salto KS. The name and email properties are considered owned by the user.

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Endpoint: "/v1.1/sites/{site_id}/users/{id}"
Method: PATCH

Parameters:
Path {
site_id;
type: string, format: uuid;
required

Id of the site

site_id
}(string) Path {
id;
type: string, format: uuid;
required

Id of the site user

id
}(string) Body (application/json): {
first_name;
type: string

The first name of the user, only editable if it has no profile.

"first_name"
: "string",
last_name;
type: string

The last name of the user, only editable if it has no profile.

"last_name"
: "string",
email;
type: string

The email of the user, only editable if it has no profile. This will result in an invite to create a profile.

"email"
: "string",
role_ids;
type: array

The roles assigned to the user

"role_ids"
: [ "00000000-0000-0000-0000-000000000000" ],
alias;
type: string

The alias label for the site user

"alias"
: "string",
tag_id;
type: string, format: uuid;

Tag Id of the user

"tag_id"
: "string",
toggle_easy_office_mode;
type: boolean

Indicates if the user can toggle easy office mode

"toggle_easy_office_mode"
: boolean,
toggle_manual_office_mode;
type: boolean

Indicates if the user can toggle manual office mode

"toggle_manual_office_mode"
: boolean,
blocked;
type: boolean

Indicates if the user is blocked in this site

"blocked"
: boolean,
override_privacy_mode;
type: boolean

Indicates if the user can override privacy mode in this site, false by default

"override_privacy_mode"
: boolean,
use_pin;
type: boolean

Indicates if the user is able to use pin in this site

"use_pin"
: boolean }
Response Content Type (application/json):
{
  
id;
type: string, format: uuid;

The id of the site user

"id"
: "string",
user;

The details of the user

"user"
: [ {
email;
type: string

email of the user

"email"
: "string",
image_url;
type: string

The url of the profile picture

"image_url"
: "string",
tag_number;
type: string

Tag number

"tag_number"
: "string",
is_managed_by_current_site;
type: boolean

Wether the user is managed by the selected site

"is_managed_by_current_site"
: boolean,
has_profile;
type: boolean

Wether the user has its own profile

"has_profile"
: boolean,
id;
type: string, format: uuid;

id of the user

"id"
: "string",
first_name;
type: string

First name of the user

"first_name"
: "string",
last_name;
type: string

Last name of the user

"last_name"
: "string" } ],
roles;
type: array

The roles assigned to the user

"roles"
: [ {
id;
type: string, format: uuid;

The id of the role

"id"
: "string",
customer_reference;
type: string

The name of the role

"customer_reference"
: "string",
code;
type: string

The code of the role

"code"
: "string",
parent_id;
type: string, format: uuid;

The id of the parent role

"parent_id"
: "string",
is_hierarchical;
type: boolean

Is role hierarchical

"is_hierarchical"
: boolean } ],
alias;
type: string

The alias label for the site user

"alias"
: "string",
toggle_easy_office_mode;
type: boolean

Indicates if the user can toggle easy office mode

"toggle_easy_office_mode"
: boolean,
toggle_manual_office_mode;
type: boolean

Indicates if the user can toggle manual office mode

"toggle_manual_office_mode"
: boolean,
remote_access;
type: boolean

Indicates if the user can execute remote openings

"remote_access"
: boolean,
blocked;
type: boolean

Indicates if the user is blocked in this site (all tags and remote openings)

"blocked"
: boolean,
tag_owned_by_this_site;
type: boolean

Indicates if the users tag is owned by this site

"tag_owned_by_this_site"
: boolean,
subscription_state;
type: string

The state of the site user subscription

"subscription_state"
: "string",
override_privacy_mode;
type: boolean

Indicates if the user can override privacy mode in this site, false by default

"override_privacy_mode"
: boolean,
use_pin;
type: boolean

Indicates if the user is able to use pin in this site

"use_pin"
: boolean }