Create SCIM token

Create or rotate the bearer token your identity provider uses for SCIM provisioning.

POSThttps://api.tried.com.au/workspace/scim-token

Creates a new SCIM bearer token and turns SCIM on. If a token already exists, it is replaced and the old one stops working at once. Only a SHA-256 hash is stored, so copy the token from the response. Admin only.

Request#

This endpoint takes no path, query or body parameters.

Example request#

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

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

import os, requests

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

Response#

200 OK

{
  "token": "scim_4f2a7c9e1b3d5f7a9c1e3b5d7f9a1c3e5b7d9c1e",
  "base_url": "https://api.tried.com.au/scim/v2"
}

Field	Type	Description
`token`	string	The SCIM token, `scim_` plus 48 hex characters. Shown only once.
`base_url`	string	SCIM base URL to give your identity provider.

The rotation is written to the audit log as workspace.scim_token_rotate. See SCIM 2.0 endpoints for what the token can do.

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.