ReferenceAdmin Centre API

Organisation

The organisation itself: its record, name and type (MSP or company), whether Bramble support may access it, and what the signed-in admin is allowed to manage.

Method	Path	Summary
GET	`/v1/admin/isadmin`	Can the caller use the Admin Centre?
GET	`/v1/admin/tenant/info`	Get the organisation
PATCH	`/v1/admin/tenant/support-access`	Allow or stop Bramble support access
PATCH	`/v1/admin/tenant/name`	Rename the organisation
GET	`/v1/admin/tenant/monitoring/summary`	Health summary for the Admin Centre home page
PATCH	`/v1/admin/tenant/org-type`	Set the organisation type

#Can the caller use the Admin Centre?

GET/v1/admin/isadmin

Returns whether the signed-in person can open the Admin Centre and which sections their roles unlock. Use it to check an API key's reach.

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

Response 200

Errors

Status	Message
403	Insufficient permissions

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/isadmin', {
  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/isadmin",
    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/isadmin' -Headers $headers

#Get the organisation

GET/v1/admin/tenant/info

Get the caller's tenant record. Requires the GLOBAL_ADMIN role. Returns the full tenants row (SELECT *) for the caller's own tenant.

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

Response 200

Field	Type	Description
`tenant`	any

Example response

JSON

{
  "tenant": null
}

Errors

Status	Message
404	Tenant not found

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/info', {
  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/info",
    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/info' -Headers $headers

#Allow or stop Bramble support access

PATCH/v1/admin/tenant/support-access

Allow or stop Bramble support access to this tenant. "Requires the GLOBAL_ADMIN role. Body: enabled (boolean)."

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

Request body JSON

Name	Type	Description
`enabled`	boolean	`true` lets Bramble support sign in to help; `false` stops it.

Response 200

Field	Type	Description
`success`	boolean
`support_access`	boolean

Example response

JSON

{
  "success": true,
  "support_access": false
}

Errors

Status	Message
400	enabled must be true or false

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/support-access' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

JavaScript

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

Python

import os, requests

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

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
$body = '{"enabled":true}'
Invoke-RestMethod -Method PATCH -Uri 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/support-access' -Headers $headers -ContentType 'application/json' -Body $body

#Rename the organisation

PATCH/v1/admin/tenant/name

Set the tenant's organisation name. Requires the GLOBAL_ADMIN role. name is required, max 100 characters.

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

Request body JSON

Name	Type	Description
`name`	string	The organisation's name, up to 100 characters.

Response 200

Field	Type	Description
`success`	boolean
`name`	string

Example response

JSON

{
  "success": true,
  "name": "Example name"
}

Errors

Status	Message
400	Organisation name is required
400	Organisation name must be 100 characters or fewer

Example request

Bash

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

JavaScript

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

Python

import os, requests

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

PowerShell

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

#Health summary for the Admin Centre home page

GET/v1/admin/tenant/monitoring/summary

get:

Address: https://<your-org>.brambleit.cloud/api/v1/admin/tenant/monitoring/summary
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Permission (any of): audit.view.

Response 200

Field	Type	Description
`signIns`	object
`signIns.success`	any
`signIns.failure`	any
`signIns.interrupted`	any
`signIns.users`	array of any
`events`	object
`events.total`	integer
`events.admin`	any
`events.failed`	any
`sessions`	object
`sessions.active`	boolean

Example response

JSON

{
  "signIns": {
    "success": null,
    "failure": null,
    "interrupted": null,
    "users": []
  },
  "events": {
    "total": 3,
    "admin": null,
    "failed": null
  },
  "sessions": {
    "active": true
  }
}

Example request

Bash

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

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/admin/tenant/monitoring/summary', {
  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/monitoring/summary",
    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/monitoring/summary' -Headers $headers

#Set the organisation type

PATCH/v1/admin/tenant/org-type

msp or company. Decides which apps are switched on by default in the launcher.

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

Request body JSON

Name	Type	Description
`org_type`required	string: "msp" \| "company"

Response 200

Field	Type	Description
`success`	boolean

Example response

JSON

{
  "success": true,
  "…await svc.listForTenant(": "…"
}

Example request

Bash

curl -X PATCH 'https://<your-org>.brambleit.cloud/api/v1/admin/tenant/org-type' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"org_type":"msp"}'

JavaScript

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

Python

import os, requests

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

PowerShell

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

Was this page helpful?