[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Custom Role

Description

Get custom role by name.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Member ✔️ ✔️
Organization Owner ✔️ ✔️

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}
Copy

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
Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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

string
displayName Optional

string
lastModifiedBy Optional

string
name Optional

array of string
permissions Optional
Errors

Errors

400

Invalid request body


401

Unauthorized


403

Forbidden


404

Not Found


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/csp/gateway/iam-roles-mgmt/api/orgs/{orgId}/custom-roles/{roleName}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,org_member
x-slo-tier: TIER2


Feedback

Was this page helpful?