Skip to main content

Create organization role

Create a custom role under an organization. This custom role will only be available for assignment to the principles within the organization.

Path Parameters
    orgId string required

    The organization ID to which the role belongs to.

Request Body required
    name string
    permissions string[]
    metadata object
    title string
Responses

A successful response.


Schema
    role object
    id string
    name string
    permissions string[]
    title string
    metadata object
    createdAt date-time

    The time the role was created.

    updatedAt date-time

    The time the role was last updated.

    orgId string
    state string
POST /v1beta1/organizations/:orgId/roles

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
orgId — path required
Body required
{
"name": "string",
"permissions": [
"string"
],
"metadata": {},
"title": "string"
}
curl / cURL
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:orgId/roles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"permissions": [
"string"
],
"metadata": {},
"title": "string"
}'