Skip to main content
POST
/
api
/
groups
Create group
curl --request POST \
  --url https://api.example.com/api/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "users": [
    123
  ],
  "permissions": [
    123
  ]
}
'
{
  "id": 123,
  "name": "<string>",
  "users": [
    123
  ],
  "permissions": [
    123
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Body

application/json
​
name
string
required

Group name

​
users
integer[]
required

List of user IDs

​
permissions
integer[]
required

List of permission IDs

Response

Group created successfully

Group object with all details

​
id
integer
required

Group ID

​
name
string
required

Group name

​
users
integer[]

List of user IDs in this group

​
permissions
integer[]

List of permission IDs for this group

​
created_at
string<date-time>

Group creation timestamp

​
updated_at
string<date-time>

Group last update timestamp