API reference · CAIN Identity

Suspend Identity

POST /fabric/identity/{identity_id}/suspend

Last reviewed 2026-10-02

POST /fabric/identity/{identity_id}/suspend

Suspend an identity. Suspended identities cannot authenticate.

Parameters

Name	In	Type
`identity_id` required	path	string
`reason`	query	string or null
`tenant`	query	string or null

Responses

Status	Meaning	Body
`200`	Successful Response	object
`422`	Validation Error	`HTTPValidationError`
`401`	No key, or a key that is not valid	JSON `detail`
`429`	Rate limit for your plan reached; retry after the Retry-After seconds	JSON `detail`

Try it

Your API key X-API-Key Remember the key in this tab onlyidentity_id pathreason querytenant query

This call changes data in the account the key belongs to.

The request goes from your browser straight to this site. Your key is not stored unless you tick the box, and then only in this tab's session storage.

Code

curl -sS -X POST 'https://cainstudio.online/fabric/identity/<identity_id>/suspend' \
  -H "X-API-Key: $CAIN_API_KEY"

import json, os, urllib.request

req = urllib.request.Request('https://cainstudio.online/fabric/identity/<identity_id>/suspend', method='POST',
    headers={"X-API-Key": os.environ["CAIN_API_KEY"]})
with urllib.request.urlopen(req, timeout=60) as r:
    print(r.status, json.load(r))

const res = await fetch("https://cainstudio.online/fabric/identity/<identity_id>/suspend", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.CAIN_API_KEY!,
  },
});
console.log(res.status, await res.json());

Schemas used

HTTPValidationError · ValidationError

← Rotate Credentials · all 18 CAIN Identity calls · Verify Credential →

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account → · Try the sandbox · See the whole ecosystem