Role user group maps

A role user group map associates a role with a user group. A user group can have more than one assigned role.

Roles are used in companies that have role-based permissions. Companies with user-based permissions do not use roles.

List role user group maps

get/objects/company-config/role-user-group-map

Returns a collection with a key, ID, and link for each role user group map. This operation is mostly for use in testing; use the query service to find role user group maps that meet certain criteria and specify the properties that are returned.

Permissions and other requirements
SubscriptionCompany
User typeBusiness users with admin privileges
PermissionsUsers - List, Groups
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "761",
      • "id": "761",
      • "href": "/objects/company-config/role-user-group-map/761"
      }
    ],
  • "ia::meta": {
    • "totalCount": 1,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a role user group map
get/objects/company-config/role-user-group-map/{key}
Returns detailed information for a specified role user group map.



Permissions and other requirements



SubscriptionCompany


User typeBusiness users with admin privileges


PermissionsUsers - List, View, and Groups







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the role user group map.


 
 Example:  761
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "761",
    • "id": "761",
    • "role": {
      • "key": "805",
      • "id": "::SYS::Multi Entity Shared-ROLE",
      • "href": "/objects/company-config/role/805"
      },
    • "userGroup": {
      • "key": "1",
      • "id": "Bypass group",
      • "href": "/objects/company-config/user-group/1"
      },
    • "audit": {
      • "createdDateTime": "2025-01-15T21:58:11Z",
      • "modifiedDateTime": "2025-01-15T21:58:11Z",
      • "createdBy": "158",
      • "modifiedBy": "158"
      },
    • "href": "/objects/company-config/role-user-group-map/761"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query role user group maps
post/services/core/query
Use the query service to find role user group maps that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}