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

Patch Custom Role

Description

Update custom role’s description and/or displayName.

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}
Copy

Path Parameters

Path Parameters

string
orgId Required

orgId

Parameter Serialization Style: simple Explode:false

string
roleName Required

Custom role name to update

Parameter Serialization Style: simple Explode:false

Request Body

Request Body

CustomRoleUpdateRequest of mimetype application/json Required
{
	"description": "string",
	"displayName": "string"
}
string
description Optional

Custom role description


string
displayName Optional

Custom role display name

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns CustomRoleDto of type application/json
{
	"createdBy": "string",
	"description": "string",
	"displayName": "string",
	"lastModifiedBy": "string",
	"name": "string",
	"permissions": [
		"string"
	]
}
string
createdBy Optional

string
description Optional

Description of the custom role


string
displayName Optional

Display name of the custom role


string
lastModifiedBy Optional

string
name Optional

Name of the custom role


array of string
permissions Optional

Permissions of the custom role

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 '{"description":"string","displayName":"string"}' https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}
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?