Recent searches

in
Developer ReferenceAPI

Groups

On this page

Get a Permission Group's details

GET/api/v0/groups/{group_uuid}
Path parameters:
group_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid} \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "permissions": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "resource": "string",
      "global_scope": true,
      "group_scope_uuid": "string",
      "base_domain_scope_uuid": "string",
      "project_scope_uuid": "string",
      "site_scope_uuid": "string",
      "file_glob": "string",
      "except": true,
      "group_id": 0,
      "group_uuid": "string",
      "organisation_uuid": "string"
    }
  ]
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Update a Permission Group's name and permissions

PUT/api/v0/groups/{group_uuid}
Path parameters:
group_uuidUUIDRequired#
Request body:
namestring#
permissionsArray<object>#
resourcestring#
exceptboolean#
global_scopeboolean#
group_scope_uuidstring#
site_scope_uuidstring#
base_domain_scope_uuidstring#
project_scope_uuidstring#
file_globstring#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid} \
  -X PUT \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "permissions": [
      {
        "resource": "string",
        "except": true,
        "global_scope": true,
        "group_scope_uuid": "string",
        "site_scope_uuid": "string",
        "base_domain_scope_uuid": "string",
        "project_scope_uuid": "string",
        "file_glob": "string"
      }
    ]
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "permissions": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "resource": "string",
      "global_scope": true,
      "group_scope_uuid": "string",
      "base_domain_scope_uuid": "string",
      "project_scope_uuid": "string",
      "site_scope_uuid": "string",
      "file_glob": "string",
      "except": true,
      "group_id": 0,
      "group_uuid": "string",
      "organisation_uuid": "string"
    }
  ]
}
Response
402FeatureNotOnPlan
JSON
Copied to clipboard
{
  "errors": {}
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Delete a Permission Group

DELETE/api/v0/groups/{group_uuid}
Path parameters:
group_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid} \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Leave a Permission Group

DELETE/api/v0/groups/{group_uuid}/leave
Path parameters:
group_uuidUUIDRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/leave \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Left the group
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

List the Members of a Permission Group

GET/api/v0/groups/{group_uuid}/members
Path parameters:
group_uuidUUIDRequired#
Filters:
searchstring#

Filter Members by name or email

Sorting:
sort_attributestring#

Attribute to sort the results by

Defaults to: "created_at"

Allowed values: id uuid email first_name last_sign_in_at created_at

sort_directionstring#

Direction to sort the results

Defaults to: "DESC"

Allowed values: ASC DESC

Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/members \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "first_name": "string",
    "surname": "string",
    "email": "string",
    "otp_required_for_login": true
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Add a Member to a Permission Group

POST/api/v0/groups/{group_uuid}/members
Path parameters:
group_uuidUUIDRequired#
Request body:
emailstringRequired#

The email to invite. If it doesn't match an existing Organization Member, they get a pending invite.

accept_billing_increaseboolean#

Accept any billing increase. Without this, the request will fail if you exceed the number of seats in your Subscription Plan.

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/members \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "accept_billing_increase": true
  }'
Terminal
Responses:
200OK
JSON
Copied to clipboard
{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "id": 0,
  "group_id": 0,
  "user_id": 0,
  "group_uuid": "string",
  "user_uuid": "string",
  "user": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "first_name": "string",
    "surname": "string",
    "email": "string",
    "otp_required_for_login": true
  }
}
Response
402FeatureNotOnPlan
JSON
Copied to clipboard
{
  "errors": {}
}
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Remove a Member from a Permission Group

DELETE/api/v0/groups/{group_uuid}/members
Path parameters:
group_uuidUUIDRequired#
Query parameters:
emailstringRequired#

Email of the Member to remove

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/members \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

List the pending Members of a Permission Group

GET/api/v0/groups/{group_uuid}/pending-members
Path parameters:
group_uuidUUIDRequired#
Pagination:
pageinteger#

Page number to fetch (1-indexed)

itemsinteger#

Number of items per page

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/pending-members \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
200OK
JSON
Copied to clipboard
[
  {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "id": 0,
    "email": "string",
    "organisation_uuid": "string",
    "group": {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "id": 0,
      "creation_type": "string",
      "organisation_id": 0,
      "name": "string",
      "organisation_uuid": "string"
    }
  }
]
Response
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response

Cancel a pending Permission Group invitation

DELETE/api/v0/groups/{group_uuid}/pending-members
Path parameters:
group_uuidUUIDRequired#
Query parameters:
emailstringRequired#

Email of the pending Member to remove

Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/pending-members \
  -X DELETE \
  -H "X-API-KEY: <your-api-key>"
Terminal
Responses:
204Deleted
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
422Unprocessable
JSON
Copied to clipboard
{
  "errors": {}
}
Response

Resend a pending Permission Group invitation email

POST/api/v0/groups/{group_uuid}/pending-members/resend
Path parameters:
group_uuidUUIDRequired#
Request body:
emailstringRequired#
Example request:
Bash
Copied to clipboard
curl https://app.cloudcannon.com/api/v0/groups/{group_uuid}/pending-members/resend \
  -X POST \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string"
  }'
Terminal
Responses:
204Invitation resent
403Forbidden
JSON
Copied to clipboard
{
  "error": "string"
}
Response
Open in a new tab