Updates a custom role

PUT 
https://apis.<domain>/iam/roles/:id

This operation overwrites all fields excepting ID, including those omitted from the request, so be sure to specify all properties. Properties that you do not include are reset to empty values.

Authorization Action:

iam:roles:update

Request

Path Parameters

id stringrequired

Unique ID. Cannot be changed.

application/json

Body

required

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 PUT 'https://apis.<domain>/iam/roles/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "My Updated Custom Application Manager Role",
  "actions": [
    "applications:*",
    "iam:tenants:list"
  ]
}'

Request Collapse all

Base URL

https://apis.<domain>

Parameters

id — pathrequired

Body required

{
  "name": "My Updated Custom Application Manager Role",
  "actions": [
    "applications:*",
    "iam:tenants:list"
  ]
}