curl --request POST \
--url https://api2.rhombussystems.com/api/permission/getPermissionGroups \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/permission/getPermissionGroups"
payload = {}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api2.rhombussystems.com/api/permission/getPermissionGroups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/permission/getPermissionGroups")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"error": true,
"errorMsg": "<string>",
"groupMembership": {},
"partnerMembership": {},
"permissionGroups": [
{
"accessControlLocationAccessMap": {},
"accessibleLocations": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"assignablePermissionGroups": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentCompositeGranularAccessMap": {},
"defaultAccessControlPermissionForNewLocations": "READONLY",
"defaultPermissionForNewLocations": "READONLY",
"description": "<string>",
"deviceAccessMap": {},
"functionalityList": [
"DEVICE_ADMINISTRATION"
],
"inLine": true,
"installer": true,
"locationAccessMap": {},
"locationGranularAccessMap": {},
"mutable": true,
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"restrictMobileSignIn": true,
"storedInS3": true,
"superAdmin": true,
"userPermissionGroupAccessMap": {},
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Get permission groups
Get details about all permission groups in organization
curl --request POST \
--url https://api2.rhombussystems.com/api/permission/getPermissionGroups \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/permission/getPermissionGroups"
payload = {}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api2.rhombussystems.com/api/permission/getPermissionGroups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/permission/getPermissionGroups")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"error": true,
"errorMsg": "<string>",
"groupMembership": {},
"partnerMembership": {},
"permissionGroups": [
{
"accessControlLocationAccessMap": {},
"accessibleLocations": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"assignablePermissionGroups": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentCompositeGranularAccessMap": {},
"defaultAccessControlPermissionForNewLocations": "READONLY",
"defaultPermissionForNewLocations": "READONLY",
"description": "<string>",
"deviceAccessMap": {},
"functionalityList": [
"DEVICE_ADMINISTRATION"
],
"inLine": true,
"installer": true,
"locationAccessMap": {},
"locationGranularAccessMap": {},
"mutable": true,
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"restrictMobileSignIn": true,
"storedInS3": true,
"superAdmin": true,
"userPermissionGroupAccessMap": {},
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
api-token, api, partner-api-token, partner-api Body
Request object for getting all permission groups in the organization.
Response
OK
Response object containing permission groups and membership information for the organization.
Map of permission group UUIDs to list of user UUIDs in each group
Show child attributes
Show child attributes
Map of partner UUIDs to list of user UUIDs in each partner organization
Show child attributes
Show child attributes
List of permission groups in the organization
Show child attributes
Show child attributes