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.
application/json
Request Body required
name string
permissions string[]
metadata object
title string
scopes string[]
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
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
scopes string[]
{
"role": {
"id": "string",
"name": "string",
"permissions": [
"string"
],
"title": "string",
"metadata": {},
"createdAt": "2023-06-07T05:39:56.961Z",
"updatedAt": "2023-06-07T05:39:56.961Z",
"orgId": "string",
"state": "string",
"scopes": [
"string"
]
}
}
Bad Request - The request was malformed or contained invalid parameters.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
code int32
message string
details object[]
@type string
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Loading...