Retrieve IAM Role

GET /iam-role/{id}

Path parameters

  • id string(uuid) Required

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • id string(uuid)

      IAM Role ID

    • name string

      IAM Role name

      Minimum length is 1, maximum length is 255.

    • description string

      IAM Role description

      Minimum length is 1, maximum length is 255.

    • permissions array[string]

      IAM Role permissions

      Values are bypass-governance-retention or reset-iam-organization-policy.

    • labels object
      Hide labels attribute Show labels attribute object
      • * string Additional properties
    • editable boolean

      IAM Role mutability

    • policy object

      Policy

      Hide policy attributes Show policy attributes object
      • default-service-strategy string Required

        IAM default service strategy

        Values are allow or deny.

      • services object Required

        IAM services

        Hide services attribute Show services attribute object
        • * object Additional properties
          Hide * attributes Show * attributes object
          • type string

            Values are rules, allow, or deny.

          • rules array[object]
            Hide rules attributes Show rules attributes object
            • action string

              Values are allow or deny.

            • expression string
            • resources array[string]
GET /iam-role/{id} 
curl \
 --request GET 'https://api-ch-gva-2.exoscale.com/v2/iam-role/{id}'
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "description": "string",
  "permissions": [
    "bypass-governance-retention"
  ],
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "editable": true,
  "policy": {
    "default-service-strategy": "allow",
    "services": {
      "additionalProperty1": {
        "type": "rules",
        "rules": [
          {
            "action": "allow",
            "expression": "string",
            "resources": [
              "string"
            ]
          }
        ]
      },
      "additionalProperty2": {
        "type": "rules",
        "rules": [
          {
            "action": "allow",
            "expression": "string",
            "resources": [
              "string"
            ]
          }
        ]
      }
    }
  }
}