Skip to content

POST /a/role

Search Roles

Body Parameters

Name Description Type Required
CountOnly Return counts only, no actual results boolean
GroupBy Group results by integer
Limit Limit number of results string
Offset Start listing at a given position string
Operation Combine Single Queries with AND or OR #/definitions/serviceOperationType
Queries List of atomic queries that will be combined using the Operation type (AND / OR) array
ResourcePolicyQuery Policies query for specifying the search context #/definitions/restResourcePolicyQuery

Body Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "CountOnly": true,
  "GroupBy": 10,
  "Limit": "string",
  "Offset": "string",
  "Operation": "string",
  "Queries": [
    {
      "HasAutoApply": true,
      "IsGroupRole": true,
      "IsTeam": true,
      "IsUserRole": true,
      "Label": "string",
      "Uuid": [
        "string"
      ],
      "not": true
    }
  ],
  "ResourcePolicyQuery": {
    "Type": "string",
    "UserId": "string"
  }
}

Response Example (200)

Response Type /definitions/restRolesCollection

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "Roles": [
    {
      "AutoApplies": [
        "string"
      ],
      "ForceOverride": true,
      "GroupRole": true,
      "IsTeam": true,
      "Label": "string",
      "LastUpdated": 10,
      "Policies": [
        {
          "Action": "string",
          "Effect": "string",
          "JsonConditions": "string",
          "Resource": "string",
          "Subject": "string",
          "id": "string"
        }
      ],
      "PoliciesContextEditable": true,
      "UserRole": true,
      "Uuid": "string"
    }
  ],
  "Total": 10
}