Update User Group

PATCH /node/api/user-groups/:id

Updates a user group according to data provided in a request body.
Permissions: manage-users.

Request parameters

Path parameters

Parameter
Type
Description
id
String
required
The ID of a user group to be updated.

Body parameters

See the User Group model.

Response description

See the User Group model.

Examples

Request examples

Bash
JavaScript
NodeJS
Python
1
login=<...>
2
password=<...>
3
saymon_hostname=<...>
4
group_id=<...>
5
url=https://$saymon_hostname/node/api/user-groups/$group_id
6
7
curl -X PATCH $url -u $login:$password \
8
-H "Content-Type: application/json" \
9
-d @- <<EOF
10
{
11
"name": "administrators"
12
}
13
EOF
Copied!
1
let login = <...>
2
let password = <...>
3
let saymonHostname = <...>
4
let groupId = <...>
5
let path = "/node/api/user-groups/" + groupId;
6
let auth = "Basic " + btoa(login + ":" + password);
7
8
let headers = new Headers();
9
headers.append("Content-Type", "application/json");
10
headers.append("Authorization", auth);
11
12
let data = JSON.stringify({
13
"name": "administrators"
14
});
15
16
let requestOptions = {
17
method: "PATCH",
18
headers: headers,
19
body: data
20
};
21
22
fetch(saymonHostname + path, requestOptions)
23
.then(response => response.text())
24
.then(result => console.log(result))
25
.catch(error => console.log("error", error));
Copied!
1
const http = require("http");
2
3
let login = <...>
4
let password = <...>
5
let saymonHostname = <...>
6
let groupId = <...>
7
let path = "/node/api/user-groups/" + groupId;
8
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
9
10
let options = {
11
"method": "PATCH",
12
"hostname": saymonHostname,
13
"headers": {
14
"Authorization": auth,
15
"Content-Type": "application/json"
16
},
17
"path": path
18
};
19
20
let req = http.request(options, function (res) {
21
let chunks = [];
22
23
res.on("data", function (chunk) {
24
chunks.push(chunk);
25
});
26
27
res.on("end", function (chunk) {
28
let body = Buffer.concat(chunks);
29
console.log(body.toString());
30
});
31
32
res.on("error", function (error) {
33
console.error(error);
34
});
35
});
36
37
let data = JSON.stringify({
38
name: "administrators"
39
});
40
41
req.write(data);
42
req.end();
Copied!
1
import requests
2
import json
3
4
login = <...>
5
password = <...>
6
saymon_hostname = <...>
7
group_id = <...>
8
url = "https://" + saymon_hostname + "/node/api/user-groups/" + group_id
9
10
body = {
11
"name": "administrators"
12
}
13
14
response = requests.request("PATCH", url, json=body, auth=(login, password))
15
print(response.text)
Copied!

Response example

1
{
2
"id": "5e78c8c188c61a1fbf34b675",
3
"name": "administrators",
4
"permissions": [],
5
"eventFilter": []
6
}
Copied!
Last modified 1yr ago