Role user maps

This object provides information about the roles assigned to users.

List role user maps

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

Returns a collection with a key, ID, and link for each role user map.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  51
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "618",
    • "id": "618",
    • "role": {
      • "key": "740",
      • "id": "::SYS::Multi Entity Shared-ROLE-FOR - BTI",
      • "href": "/objects/company-config/role/740"
      },
    • "user": {
      • "key": "4",
      • "id": "BTI",
      • "href": "/objects/company-config/user/4"
      },
    • "audit": {
      • "createdDateTime": "2023-08-18T09:43:13Z",
      • "modifiedDateTime": "2023-08-18T09:43:13Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/company-config/role-user-map/618"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query role user maps
post/services/core/query
Use the query service to find role user maps that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples