Patch Custom Role Using PATCH

• Custom Roles

Update custom role's description and/or displayName.

Access Policy

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

Request

URI

PATCH

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

COPY

Path Parameters

string

orgId

Required

orgId

string

roleName

Required

Custom role name to update

---

Request Body

CustomRoleUpdateRequest of type(s) application/json

Required

{
    "description": "string",
    "displayName": "string"
}

string

description

Optional

Constraints: minLength: 1 maxLength: 256

Custom role description

string

displayName

Optional

Constraints: minLength: 1 maxLength: 100

Custom role display name

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Hide Details

Success

Returns CustomRoleDto of type(s) application/json

"CustomRoleDto Object"

string

createdBy

Optional

createdBy

string

description

Optional

Description of the custom role

string

displayName

Optional

Display name of the custom role

string

lastModifiedBy

Optional

lastModifiedBy

string

name

Optional

Name of the custom role

array of string

permissions

Optional

Permissions of the custom role

400

Hide Details

Invalid request body

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

Hide Details

Unauthorized

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

Hide Details

Forbidden

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Hide Details

Not Found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

Hide Details

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

Hide Details

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

Hide Details

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
                

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Custom Roles Operations

GET

Get Custom Roles Using GET

POST

Create Custom Role Using POST

DELETE

Delete Custom Role Using DELETE

GET

Get Custom Role Using GET

PATCH

Patch Custom Role Using PATCH

PATCH

Patch Custom Role Permissions Using PATCH