Get All User Groups
Returns an array of all existing user groups.
Request
HTTP Request
Permissions
A user needs manage-users
permissions to get all user groups in the system. Users without those permissions will only get the groups they are a part of.
Path parameters
No parameters required.
Request body
The request body is empty.
Response
Returns an array of all user groups the sender has access to. If a user who sent this request has manage-users
permissions, they will get every all user groups in the system. Otherwise, they will only get the groups they're a part of.
See the User Group model for information on returned fields.
Example
Request
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/user-groups";
let auth = "Basic " + btoa(login + ":" + password);
let headers = new Headers();
headers.append("Authorization", auth);
let requestOptions = {
method: "GET",
headers: headers
};
fetch(saymonHostname + path, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));
const http = require("http");
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/user-groups";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "GET",
"hostname": saymonHostname,
"headers": {
"Authorization": auth
},
"path": path
};
let req = http.request(options, function (res) {
let chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
let body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();