Creates a custom role

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

Creates a new role to be used in the policies that control permissions.

A role defines the scope of actions in a policy statement.

Authorization Action:

iam:roles:create

Request

application/json

Body

required

Does not contain type as the enduser can only create 'custom' roles.

id stringrequired

Unique ID. Cannot be changed.

name stringrequired

Name for the role.

actions string[]required

List of actions that this role scopes to.

tenants string[]

List of tenants this role belongs to.

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

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

• CURL

curl -L -X POST 'https://apis.<domain>/iam/roles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "id": "custom-role",
  "name": "My Custom Application Manager Role",
  "actions": [
    "applications:*",
    "iam:tenants:list"
  ]
}'

Request Collapse all

Base URL

https://apis.<domain>

Body required

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