Skip to content

API reference

SCIM tokens

The tokens identity providers use to read people and teams from Bizisy's SCIM 2.0 service, and what they see. Creating and revoking tokens happen in the web app.

3 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.

List SCIM tokens#

POST/v1/org/scim.tokens.listRead

The SCIM service an identity provider (Okta, Microsoft Entra, JumpCloud, …) reads the company's people and teams from: base_url, the tokens (name, last 4 characters, created, last used; never the token itself), and what the provider sees (shared: people and teams listed). The service is read only: people (userName = work email, name, title, team, manager, active = works here today; starters from 14 days before their first day and leavers up to 90 days after their last day, with active false) and teams as groups. Never private or pay data, never a future change. A token belongs to the company: it keeps working until it is revoked, also after the person who made it leaves. Owners and admins.

Who can call it
Manage key owner admin
MCP tool
org_scim_tokens_list on HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • base_urlstringrequired
  • docs_urlstringrequired
  • max_tokensintegerrequired
  • tokensobject[]required
    5 fields
    • idstringrequired
    • namestringrequired
    • last4stringrequired

      The token’s last 4 characters, to tell tokens apart.

    • created_atstringrequired
    • last_used_atstring | nullrequired
  • sharedobjectrequired
    3 fields
    • usersintegerrequired
    • activeintegerrequired
    • groupsintegerrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/org/scim.tokens.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "base_url": "https://api.bizisy.com/scim/v2",
    "docs_url": "https://developers.bizisy.com/docs/guides/scim",
    "max_tokens": 5,
    "tokens": [
      {
        "id": "01k0000000000000000000000s",
        "name": "Okta",
        "last4": "x9Qa",
        "created_at": "2026-10-01T09:00:00.000Z",
        "last_used_at": "2026-10-04T10:00:00.000Z"
      }
    ],
    "shared": {
      "users": 27,
      "active": 25,
      "groups": 6
    }
  }
}

Create a SCIM token#

POST/v1/org/scim.tokens.createWrite

Creates a token an identity provider uses to read the company's people and teams over SCIM (Authorization: Bearer <token>, base_url). The token is in the result once and never again: Bizisy keeps only a hash. At most 5 tokens. name says which tool uses it ("Okta"). Owners and admins, in the app only.

Web app only
Refused for API keys and connected apps. An owner or admin creates SCIM tokens in the app (Integrations → SCIM): a token is never made with a key.
MCP tool
org_scim_tokens_create on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity

Input

  • namestringrequired

    Which tool uses it, e.g. "Okta".

    1–60 characters.

Returns

  • idstringrequired
  • namestringrequired
  • tokenstringrequired

    Shown once.

  • base_urlstringrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/scim.tokens.create \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Okta"}'
Response
{
  "data": {
    "id": "01k0000000000000000000000s",
    "name": "Okta",
    "token": "bzscim_01k0000000000000000000000s_c2VjcmV0c2VjcmV0c2VjcmV0c2VjcmV0c2VjcmV0c2Vj",
    "base_url": "https://api.bizisy.com/scim/v2"
  }
}

Revoke a SCIM token#

POST/v1/org/scim.tokens.revokeDestructive

Revokes a SCIM token: the identity provider using it can no longer read anything, at once. Nothing changes in the identity provider itself. Owners and admins, in the app only.

Web app only
Refused for API keys and connected apps. Revoking a SCIM token happens in the app.
MCP tool
org_scim_tokens_revoke on HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • idstringrequired

    1–40 characters.

Returns

  • idstringrequired
  • revokedtruerequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/org/scim.tokens.revoke \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"01k0000000000000000000000s"}'
Response
{
  "data": {
    "id": "01k0000000000000000000000s",
    "revoked": true
  }
}

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs