Skip to main content

Updates a custom role

PUT 

/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.

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

A successful response.

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.

Loading...