Role user group maps

This object provides information about the roles assigned to user groups.

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.

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.


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


 
 Example:  69
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-FOR - Aaron",
      • "href": "/objects/company-config/role/805"
      },
    • "userGroup": {
      • "key": "1",
      • "id": "Bypass group",
      • "href": "/objects/company-config/user-group/1"
      },
    • "audit": {
      • "createdDateTime": "2023-08-18T09:43:13Z",
      • "modifiedDateTime": "2023-08-18T09:43:13Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "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
    }
}