Get SCIM configuration

Check whether SCIM provisioning is on and how many users and groups it manages.

GEThttps://api.tried.com.au/workspace/scim

Returns the workspace's SCIM provisioning status: whether a SCIM token exists, a hint of it, the SCIM base URL and how many users and groups were provisioned. Admin only.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/workspace/scim \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/workspace/scim", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const scim = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/workspace/scim",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
scim = res.json()

Response#

200 OK

{
  "enabled": true,
  "token_hint": "scim_4f2a...9c1e",
  "base_url": "https://api.tried.com.au/scim/v2",
  "users": 14,
  "groups": 3
}

Field	Type	Description
`enabled`	boolean	`true` when a SCIM token exists.
`token_hint`	string or null	First 9 and last 4 characters of the token. The full token is shown only once, by Create SCIM token.
`base_url`	string	SCIM base URL to give your identity provider: `<API base>/scim/v2`.
`users`	integer	SCIM users provisioned in this workspace.
`groups`	integer	SCIM groups provisioned in this workspace.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope. A dashboard user without the right role gets `Requires role: admin`. API keys act as admin.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.