Create IAM Role

POST /iam-role

Body Required

  • name string Required

    IAM Role name

    Minimum length is 1, maximum length is 191.

  • IAM Role description

    Minimum length is 1, maximum length is 255.

  • permissions array[string]

    IAM Role permissions

    Value is bypass-governance-retention.

  • editable boolean

    Sets if the IAM Role Policy is editable or not (default: true). This setting cannot be changed after creation

  • labels object

    Resource labels

    Hide labels attributes Show labels attributes
  • policy object

    IAM Role Policy

    Hide policy attributes Show policy attributes


  • 200 application/json


    Hide response attributes Show response attributes object


    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • Related resource reference

      Hide reference attributes Show reference attributes
      • id string(uuid)

        Reference ID

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.

POST /iam-role
curl \
 -X POST \
 -H "Content-Type: application/json" \
 -d '{"name":"string","description":"string","permissions":["bypass-governance-retention"],"editable":true,"labels":{"key":"string"},"policy":{"default-service-strategy":"allow","services":{"type":"rules","rules":[{"action":"allow","expression":"string","resources":["string"]}]}}}'
Request examples
  "name": "string",
  "description": "string",
  "permissions": [
  "editable": true,
  "labels": {
    "key": "string"
  "policy": {
    "default-service-strategy": "allow",
    "services": {
      "type": "rules",
      "rules": [
          "action": "allow",
          "expression": "string",
          "resources": [
Response examples (200)
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  "message": "string",
  "state": "failure"