Lists all roles

GET 
https://apis.<domain>/iam/roles

Lists all compiuta-managed and custom roles.

Authorization Action:

iam:roles:list

Request

Responses

200

A successful response.

application/json

Schema

Schema

roles object[]
Array [
name string
Name for the role.
id string
Unique ID. Cannot be changed.
type compiuta.api.iam.v2.Type
Possible values: [COMPIUTA_MANAGED, CUSTOM]
Default value: COMPIUTA_MANAGED
actions string[]
List of actions this role scopes to. Will contain one or more.
tenants string[]
List of tenants this role belongs to. May be empty.
]

Example (from schema)

{
  "roles": [
    {
      "id": "custom-role",
      "name": "My Custom Application Manager Role",
      "actions": [
        "applications:*",
        "iam:tenants:list"
      ]
    },
    {
      "id": "custom-role-2",
      "name": "My Custom Application Role 2",
      "actions": [
        "infra:*"
      ]
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://apis.<domain>/iam/roles' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://apis.<domain>