[{"label":"Latest (v1.0)","version":"latest"}]
csp
Create Custom Role
DescriptionCreate custom role.
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
Path Parameters
Path Parameters
string
orgId
Required
Organization Id
Parameter Serialization Style:
simple Explode:false
Request Body
Request Body
CreateCustomRoleRequest
of mimetype application/json
Required
{
"displayName": "string",
"name": "string"
}
string
displayName
Required
Custom role display name
string as ^[a-zA-Z0-9_-]{2,30}$
name
Required
Custom role name
string
description
Optional
Custom role description
array of
string
permissions
Optional
Permissions of the role
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created
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
The requested resource could not be 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 POST -H "Content-Type: application/json" -d '{"description":"string","displayName":"string","name":"string","permissions":["string"]}' https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_admin,org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Custom Roles Operations
post
delete
get
get
patch
