Patch Custom Role Using PATCH

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

"CustomRoleUpdateRequest Object"

string

displayName

Optional

Constraints: minLength: 1 maxLength: 100

Custom role display name

string

description

Optional

Constraints: minLength: 1 maxLength: 256

Custom role description

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Success

Returns CustomRoleDto of type(s) application/json

{
    "permissions": [
        "string"
    ],
    "name": "string",
    "description": "string",
    "createdBy": "string",
    "displayName": "string",
    "lastModifiedBy": "string"
}

array of string

permissions

Optional

Permissions of the custom role

string

name

Optional

Name of the custom role

string

description

Optional

Description of the custom role

string

createdBy

Optional

createdBy

string

displayName

Optional

Display name of the custom role

string

lastModifiedBy

Optional

lastModifiedBy

400

Invalid request body

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

401

Unauthorized

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

403

Forbidden

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

404

Not Found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

errorCode

Optional

errorCode

string

cspErrorCode

Optional

cspErrorCode

integer As int32 As int32

statusCode

Optional

statusCode

string

requestId

Optional

requestId

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

PATCH

Patch Custom Role Permissions Using PATCH

DELETE

Delete Custom Role Using DELETE

PATCH

Patch Custom Role Using PATCH

GET

Get Custom Role Using GET

POST

Create Custom Role Using POST

GET

Get Custom Roles Using GET