Permission Webservice

Get permission groups

Get details about all permission groups in organization

post/api/permission/getPermissionGroups

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/permission/getPermissionGroups
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

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.

Request body

PermissionGetPermissionGroupsWSRequest required

Request object for getting all permission groups in the organization.

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
groupMembershipobject nullable

Map of permission group UUIDs to list of user UUIDs in each group

partnerMembershipobject nullable

Map of partner UUIDs to list of user UUIDs in each partner organization

warningMsgstring nullable

Example response

{
  "permissionGroups": [
    {
      "accessibleLocations": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "assignablePermissionGroups": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.