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

Create Custom Role

Description

Create custom role.

Access Policy

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

Request

Request

URL

URL


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

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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

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

The requested resource could not be found


409

The request could not be processed due to a conflict


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 -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

Vendor Extensions

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


Feedback

Was this page helpful?