List Roles

POST

https://{account-domain}.console.eon.io/api/v1/roles/list

POST

/api/v1/roles/list

curl -X POST "https://{account-domain}.console.eon.io/api/v1/roles/list?pageSize=10&pageToken=Yjk3ODZjNjktZTIwZC00NjAxLWE1MzktZjg2NGExM2IxYTZlfDE" \
     -H "Authorization: Bearer <token>"

200Successful

{
  "roles": [
    {
      "id": "daa42222-6ad2-5d37-bb26-4f2a9cba73da",
      "name": "My custom role",
      "isBuiltInRole": false,
      "permissionGrants": [
        {
          "permission": "inventory.view",
          "accessConditionId": "Non-PII only."
        }
      ],
      "accessConditions": [
        {
          "id": "Non-PII only",
          "effect": "INCLUSIVE",
          "expression": {
            "group": {
              "operator": "AND",
              "operands": [
                {
                  "resourceType": {
                    "operator": "IN",
                    "resourceTypes": [
                      "AWS_EC2",
                      "AWS_RDS"
                    ]
                  }
                },
                {
                  "environment": {
                    "operator": "IN",
                    "environments": [
                      "PROD",
                      "PROD_INTERNAL"
                    ]
                  }
                }
              ]
            },
            "resourceType": {
              "operator": "IN",
              "resourceTypes": [
                "AWS_EC2"
              ]
            },
            "dataClasses": {
              "operator": "CONTAINS_ANY_OF",
              "dataClasses": [
                "PII"
              ]
            },
            "environment": {
              "operator": "IN",
              "environments": [
                "PROD"
              ]
            },
            "apps": {
              "operator": "CONTAINS_ANY_OF",
              "apps": [
                "string"
              ]
            },
            "cloudProvider": {
              "operator": "IN",
              "cloudProviders": [
                "AWS"
              ]
            },
            "accountId": {
              "operator": "IN",
              "accountIds": [
                "string"
              ]
            },
            "sourceRegion": {
              "operator": "IN",
              "regions": [
                "string"
              ]
            },
            "vpc": {
              "operator": "IN",
              "vpcs": [
                "string"
              ]
            },
            "subnets": {
              "operator": "CONTAINS_ANY_OF",
              "subnets": [
                "string"
              ]
            },
            "resourceGroupName": {
              "operator": "IN",
              "resourceGroupNames": [
                "string"
              ]
            },
            "resourceName": {
              "operator": "CONTAINS",
              "resourceNames": [
                "string"
              ]
            },
            "resourceId": {
              "operator": "IN",
              "resourceIds": [
                "string"
              ]
            },
            "tagKeys": {
              "operator": "CONTAINS_ANY_OF",
              "tagKeys": [
                "string"
              ]
            },
            "tagKeyValues": {
              "operator": "CONTAINS_ANY_OF",
              "tagKeyValues": [
                {
                  "key": "string",
                  "value": "string"
                }
              ]
            }
          }
        }
      ],
      "restoreDestinationLimits": {
        "effect": "INCLUSIVE",
        "restoreAccountProviderIds": [
          "123456789012",
          "987654321098"
        ]
      }
    }
  ],
  "totalCount": 1,
  "nextToken": "Y2NiMGYyZmMtYjYyZi00OTc5LTgzNjQtYmQ2YjEyYzdjZTNifDE="
}

Retrieves a list of user roles.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageTokenstringOptional

Cursor that points to the first record of the next page of results. Get this value from the previous response. To preserve the results in the same order, use the same sorting and filters in the first request as all subsequent requests.

pageSizeintegerOptional>=1Defaults to 50

Maximum number of items to return in the response.

Response

Roles retrieved.

roleslist of objects

totalCountintegerOptional

Total number of roles.

nextTokenstringOptional

Cursor that points to the first record of the next page of results. Pass this value in the next request.