ReferenceAdmin Centre API

Groups

Groups of people. Groups are used to give access (apps, sites, PSA queues, single sign-on apps, security policies) to many people at once.

Method	Path	Summary
GET	`/v1/admin/tenant/groups`	List the tenant's groups with member counts
GET	`/v1/admin/tenant/groups/:id`	Get a group and its members
POST	`/v1/admin/tenant/groups`	Create a group. Requires the GLOBAL_ADMIN role
PATCH	`/v1/admin/tenant/groups/:id`	Rename a group. Requires the GLOBAL_ADMIN role
DELETE	`/v1/admin/tenant/groups/:id`	Delete a group. Requires the GLOBAL_ADMIN role
POST	`/v1/admin/tenant/groups/:id/members`	Add a user to a group
DELETE	`/v1/admin/tenant/groups/:id/members/:userId`	Remove a user from a group

#List the tenant's groups with member counts

GET/v1/admin/tenant/groups

List the tenant's groups with member counts. Requires the GLOBAL_ADMIN role.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Response 200

Field	Type	Description
`groups`	array of any

Example response

JSON

{
  "groups": []
}

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups' -Headers $headers

#Get a group and its members

GET/v1/admin/tenant/groups/:id

Get a group and its members. Requires the GLOBAL_ADMIN role.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`group`	any
`members`	array of any

Example response

JSON

{
  "group": null,
  "members": []
}

Errors

Status	Message
404	Group not found

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42' -Headers $headers

#Create a group. Requires the GLOBAL_ADMIN role

POST/v1/admin/tenant/groups

Create a group. Requires the GLOBAL_ADMIN role. group_name is required.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Request body JSON

Name	Type	Description
`group_name`required	string	The group's name.

Response 201

Field	Type	Description
`success`	boolean
`group`	object
`group.id`	integer
`group.group_name`	string

Example response

JSON

{
  "success": true,
  "group": {
    "id": 42,
    "group_name": "Example group name"
  }
}

Errors

Status	Message
400	Group name is required

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"group_name":"Example group name"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"group_name":"Example group name"}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"group_name":"Example group name"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"group_name":"Example group name"}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups' -Headers $headers -ContentType 'application/json' -Body $body

#Rename a group. Requires the GLOBAL_ADMIN role

PATCH/v1/admin/tenant/groups/:id

Rename a group. Requires the GLOBAL_ADMIN role. group_name is required.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`group_name`required	string

Response 200

Field	Type	Description
`success`	boolean

Example response

JSON

{
  "success": true
}

Errors

Status	Message
400	Group name is required
404	Group not found

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"group_name":"Example group name"}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42', {
  method: 'PATCH',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"group_name":"Example group name"}),
});
const data = await res.json();

Python

import os, requests

r = requests.patch(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"group_name":"Example group name"},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"group_name":"Example group name"}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42' -Headers $headers -ContentType 'application/json' -Body $body

#Delete a group. Requires the GLOBAL_ADMIN role

DELETE/v1/admin/tenant/groups/:id

Delete a group. Requires the GLOBAL_ADMIN role. Cascades to the group's membership rows in a transaction.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`success`	boolean

Example response

JSON

{
  "success": true
}

Errors

Status	Message
404	Group not found

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42' -Headers $headers

#Add a user to a group

POST/v1/admin/tenant/groups/:id/members

Add a user to a group. Requires the GLOBAL_ADMIN role. Validates the user belongs to the caller's tenant; uses INSERT IGNORE so re-adding an existing member is a no-op.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id/members
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`user_id`required	integer	The person to add.

Response 201

Field	Type	Description
`success`	boolean

Example response

JSON

{
  "success": true
}

Errors

Status	Message
400	user_id is required
400	User not found on this tenant
404	Group not found

Example request

Bash

curl -X POST 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_id":7}'

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"user_id":7}),
});
const data = await res.json();

Python

import os, requests

r = requests.post(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
    json={"user_id":7},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"user_id":7}'
Invoke-RestMethod -Method POST -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members' -Headers $headers -ContentType 'application/json' -Body $body

#Remove a user from a group

DELETE/v1/admin/tenant/groups/:id/members/:userId

Remove a user from a group. Requires the GLOBAL_ADMIN role.

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/:id/members/:userId
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Role: GLOBAL_ADMIN.

Path parameters

Name	Type	Description
`id`required	integer
`userId`required	integer

Response 200

Field	Type	Description
`success`	boolean

Example response

JSON

{
  "success": true
}

Errors

Status	Message
404	Membership not found

Example request

Bash

curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members/1' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members/1', {
  method: 'DELETE',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.delete(
    "https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members/1",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method DELETE -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/groups/42/members/1' -Headers $headers

Was this page helpful?