[{"label":"Latest (v1.0)","version":"latest"}]
csp

Patch Custom Role Permissions

Description

Update custom role’s permissions.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️

Request

Request

URL

URL


patch
https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}/permissions
Copy

Path Parameters

Path Parameters

string
orgId Required

orgId

Parameter Serialization Style: simple Explode:false

string
roleName Required

Custom role’s name to update

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

UpdateRolePermissionsRequest of mimetype application/json Required
{
	"permissionsToAdd": [
		"string"
	],
	"permissionsToRemove": [
		"string"
	]
}
array of string
permissionsToAdd Optional

Permissions to add to role


array of string
permissionsToRemove Optional

Permissions to remove from role

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PartialSuccessResponseString of type application/json
{
	"failed": [
		"string"
	],
	"succeeded": [
		"string"
	]
}
array of string
failed Optional

The entities for which the operation failed.


array of string
succeeded Optional

The entities for which the operation is successful.

Errors

Errors

400

Invalid request body


401

Unauthorized


403

Forbidden


404

Not Found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"permissionsToAdd":["string"],"permissionsToRemove":["string"]}' https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}/permissions
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?