Get Custom Role Using GET

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 ✔️ ✔️
Request
URI
GET
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 get

Query Parameters
string
locale
Optional

Locale for which the role description should be translated

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns CustomRoleDto of type(s) application/json 
{
    "createdBy": "string",
    "description": "string",
    "displayName": "string",
    "lastModifiedBy": "string",
    "name": "string",
    "permissions": [
        "string"
    ]
}
string
createdBy
Optional

createdBy

string
description
Optional

Description of the custom role

string
displayName
Optional

Display name of the custom role

string
lastModifiedBy
Optional

lastModifiedBy

string
name
Optional

Name of the custom role

array of string
permissions
Optional

Permissions of the custom role


400

Invalid request body

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


401

Unauthorized

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

Forbidden

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Not Found

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}
On This Page
Custom Roles Operations
GET
Get Custom Roles Using GET
POST
Create Custom Role Using POST
DELETE
Delete Custom Role Using DELETE
GET
Get Custom Role Using GET
PATCH
Patch Custom Role Using PATCH
PATCH
Patch Custom Role Permissions Using PATCH