organization.updateRole

PATCH

/v1/organization/roles/{roleId}

const url = 'https://example.com/v1/organization/roles/super_administrator';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example","policy":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/v1/organization/roles/super_administrator \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "policy": "example" }'

Changes a custom role. Every member with the role gets the new policy at once.

Authorizations

token
session

Parameters

Path Parameters

roleId

required

Any of:

string
string

string

Allowed values: super_administrator administrator administrator_read_only member auditor

Request Body^required

application/json

object

name

string

>= 1 characters <= 120 characters

description

string

<= 1000 characters

policy

string

Example ^generated

{
  "name": "example",
  "description": "example",
  "policy": "example"
}

Responses

200

Success

application/json

object

required

Any of:

string
string

string

Allowed values: super_administrator administrator administrator_read_only member auditor

name

required

string

description

required

string

builtin

required

boolean

policy

required

string

Example

{
  "id": "super_administrator"
}

400

OrganizationRequired

application/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

RoleNotFound

application/json

object

_tag

required

string

Allowed values: RoleNotFound

roleId

required

Any of:

string
string

string

Allowed values: super_administrator administrator administrator_read_only member auditor

Example

{
  "_tag": "RoleNotFound",
  "roleId": "super_administrator"
}

409

@nmnmcc/ability/Authorizer/Pending | RoleInUse | RoleReadOnly

application/json

Any of:

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}

organization.updateRole

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required

Example ^generated