Get Role

GET

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

GET

/api/v1/roles/:roleId

curl https://{account-domain}.console.eon.io/api/v1/roles/daa42222-6ad2-5d37-bb26-4f2a9cba73da \
     -H "Authorization: Bearer <token>"

{
  "role": {
    "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"
      ]
    }
  }
}

Retrieves a role.

Authentication

AuthorizationBearer

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

Path parameters

roleIdstringRequiredformat: "uuid"

Role ID.

Response

Role retrieved.

roleobject

Role.

Errors

404

Not Found Error