Create group
Create a new group in an organization which serves as a container for users. The group can be assigned roles and permissions and can be used to manage access to resources. Also a group can also be assigned to other groups.
Path Parameters
The organization ID to which the group belongs to.
Request Body required
The name of the group. The name must be unique within the entire Frontier instance. The name can contain only alphanumeric characters, dashes and underscores.
The title can contain any UTF-8 character, used to provide a human-readable name for the group. Can also be left empty.
Metadata object for groups that can hold key value pairs defined in Group Metaschema. The metadata object can be used to store arbitrary information about the group such as labels, descriptions etc. The default Group Metaschema contains labels and descripton fields. Update the Group Metaschema to add more fields.
Example:{"labels": {"key": "value"}, "description": "Group description"}
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
group object
{
"group": {
"id": "string",
"name": "string",
"title": "string",
"org_id": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"users": [
{
"id": "string",
"name": "johndoe",
"title": "John Doe",
"email": "string",
"metadata": {},
"created_at": "2023-06-07T05:39:56.961Z",
"updated_at": "2023-06-07T05:39:56.961Z",
"state": "enabled",
"avatar": "string"
}
],
"members_count": 2
}
}
Bad Request - The request was malformed or contained invalid parameters.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /v1beta1/organizations/:org_id/groups
Authorization
name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic
Request
Request
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "string",
"title": "string",
"metadata": {}
}'