Get Role
GET/organizations/:organizationId/roles/:roleId
Get Role
Request
Path Parameters
organizationId stringrequired
The ID of organization.
roleId stringrequired
The ID of role.
Responses
- 200
- 401
- 403
- 422
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
data objectrequired
Data of the created role including its ID, description, policies, and timestamps.
id stringrequired
description stringrequired
policies object[]required
resources string[]required
actions string[]required
effect stringrequired
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
{
"data": {
"id": "string",
"description": "string",
"policies": [
{
"resources": [
"string"
],
"actions": [
"string"
],
"effect": "string"
}
],
"createdBy": "string",
"createdAtDateString": "string",
"createdAt": 0,
"updatedAtDateString": "string",
"updatedAt": 0
}
}
{
"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
}
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Unauthenticated",
"message": "Authentication is required and has failed or has not yet been provided."
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Forbidden",
"message": "Access to the requested resource is forbidden."
}
The input data has invalid.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The input data has invalid.
message stringrequired
The input data has invalid message.
{
"error": "string",
"message": "string"
}
{
"error": "ValidationError",
"message": "Input data validation failed."
}
Loading...