Get Custom Role Using GET
Get custom role by name.
Access Policy
Role | User Accounts | Service Accounts (Client Credentials Applications) |
---|---|---|
Organization Member | ✔️ | ✔️ |
Organization Admin | ✔️ | ✔️ |
Organization Owner | ✔️ | ✔️ |
orgId
Custom role name to get
Locale for which the role description should be translated
Success
{
"createdBy": "string",
"description": "string",
"displayName": "string",
"lastModifiedBy": "string",
"name": "string",
"permissions": [
"string"
]
}
createdBy
Description of the custom role
Display name of the custom role
lastModifiedBy
Name of the custom role
Permissions of the custom role
Invalid request body
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
Unauthorized
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
Forbidden
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
Not Found
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user has sent too many requests
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}