[{"label":"Latest (v1.0)","version":"latest"}]
csp
Patch Custom Role
DescriptionUpdate custom role’s description and/or displayName.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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
CspErrorResponse
400
Invalid request body
CspErrorResponse
401
Unauthorized
CspErrorResponse
403
Forbidden
CspErrorResponse
404
Not Found
CspErrorResponse
409
The request could not be processed due to a conflict
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
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}
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Custom Roles Operations
post
delete
get
get
patch
