Create Role

POST 
/organizations/:organizationId/roles

Create Role

Request

Path Parameters

organizationId stringrequired

The ID of the organization where the role is to be created.

application/json

Body

required

name stringrequired

The name of the role.

description string

The description of the role.

policies object[]required
The policies associated with the role. Each policy defines actions, effects, and resources.
Array [
]

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the created role including its ID, description, policies, and timestamps.
id stringrequired
description stringrequired
policies object[]required
Array [
resources string[]required
actions string[]required
effect stringrequired
]
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "description": "string",
    "policies": [
      {
        "resources": [
          "string"
        ],
        "actions": [
          "string"
        ],
        "effect": "string"
      }
    ],
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": 0,
    "updatedAtDateString": "string",
    "updatedAt": 0
  }
}

Example

{
  "data": {
    "id": "rl-admin",
    "description": "Admin role",
    "policies": [
      {
        "resources": [
          "*"
        ],
        "actions": [
          "*"
        ],
        "effect": "allow"
      }
    ],
    "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
    "createdAtDateString": "2024-01-01T00:00:00.000Z",
    "createdAt": 1704067200000,
    "updatedAtDateString": "2024-01-31T00:00:00.000Z",
    "updatedAt": 1706659200000
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...