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
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
Schema
role object
{
"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"
}
}
Bad Request - The request was malformed or contained invalid parameters.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"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
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /v1beta1/organizations/:orgId/roles
Authorization
name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic
Request
Request
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"
}'
python / requests
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"
}'
go / native
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"
}'
nodejs / axios
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"
}'
ruby / Net::HTTP
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"
}'
csharp / RestSharp
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"
}'
php / 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"
}'
java / OkHttp
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"
}'
powershell / RestMethod
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"
}'