Gets a role

GET 
/iam/roles/:id

Returns the details for a role.

Authorization Action:

iam:roles:get

Request

Path Parameters

id stringrequired

ID of the role.

Responses

200

A successful response.

application/json

Schema

Schema

role object

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)

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

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"
    }
  ]
}

Loading...