[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Custom Role
DescriptionGet custom role by name.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| 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 get
Parameter Serialization Style:
simple Explode:false
Query Parameters
Query Parameters
string
locale
Optional
Locale for which the role description should be translated
Parameter Serialization Style:
form Explode:true
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
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_admin,org_owner,org_member
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Custom Roles Operations
post
delete
get
get
patch
