Skip to main content
POST
/
api
/
projects
/
{projectId}
/
groups
Create group
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "owner"
  ],
  "filePermissions": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "permissions": [
    "owner"
  ],
  "description": "<string>",
  "filePermissions": [
    {
      "effect": "allow",
      "actions": [],
      "id": "<string>",
      "patterns": "<string>"
    }
  ],
  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
projectId
string<uuid>
required

ID of the project to create the group in

Body

application/json
​
name
string
required

Name of the group

​
description
string

Description of the group

​
permissions
enum<string>[]

List of permissions to grant to the group

Available options:
owner,
documents,
releases,
releases:manage,
releases:deploy,
releases:delete,
integrations:manage,
documents:full,
documents:view-content,
documents:edit-content,
documents:edit-view,
branches,
branches:create,
branches:merge,
branches:delete,
project:manage,
environments,
environments:manage,
environments:delete
​
filePermissions
object[] | null

File-level permissions for the group

Response

200 - application/json

The created group

The created group

​
id
string<uuid>
required

Unique identifier of the group

​
name
string
required

Name of the group

​
projectId
string<uuid>
required

ID of the project this group belongs to

​
permissions
enum<string>[] | null
required

List of permissions granted to this group

Available options:
owner,
documents,
releases,
releases:manage,
releases:deploy,
releases:delete,
integrations:manage,
documents:full,
documents:view-content,
documents:edit-content,
documents:edit-view,
branches,
branches:create,
branches:merge,
branches:delete,
project:manage,
environments,
environments:manage,
environments:delete
​
description
string

Description of the group

​
filePermissions
object[] | null

File-level permissions for this group

​
roleId
string<uuid>

ID of the access profile managing this group

​
role
object

Access profile that manages this group