Permission Webservice

Get partner permission groups

Get partner permission groups for the organization

post/api/permission/getPartnerPermissionGroups

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/permission/getPartnerPermissionGroups
  • 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

PermissionGetPartnerPermissionGroupsWSRequest required

Request object for getting partner permission groups for the organization.

Response

OK

clientPermissionGroupMapobject nullable

Map of client UUIDs to their permission group types

clientPermissionsGroupMapobject nullable
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

warningMsgstring nullable

Example response

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

Changes

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