PATCH/api/orgs/{org_id}/identities/{identity_id}

Rename or redescribe an identity

Provisioning key only. A key may change display_name and description but never active (403); enabling or disabling is done in the dashboard.

認証: AuthorizationヘッダーにBearer形式のAPIキー

パスパラメータ

  • org_idstring必須

    Your organization id (uuid). GET /api/whoami returns it.

  • identity_idstring必須

    Identity id.

リクエストボディ

  • display_namestring | null
  • descriptionstring | null
  • activeboolean | null

    Sessions only. An API key sending this field gets 403.

レスポンス

  • 200

    Updated.

    レスポンス
    • identity_idstring必須
    • display_namestring必須
    • descriptionstring | null必須
    • activeboolean必須

      False blocks minting new keys under it; existing keys keep serving until revoked.

    • is_defaultboolean必須

      The org's default identity (holds dashboard-minted keys).

    • created_atstring必須
    • updated_atstring必須
  • 401

    Missing, unknown or revoked API key.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 403

    Not a provisioning key, or a key sent active.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 404

    Unknown organization or identity.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 409

    Disabling the default identity.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 422

    No fields to update, or body validation failed.

リクエスト

curl -X PATCH https://api.experientiallabs.ai/api/orgs/3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10/identities/acme-support \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "Acme support (EU)"
}'

レスポンス

{
  "identity_id": "acme-support",
  "display_name": "Acme support (EU)",
  "description": "Customer support agent",
  "active": true,
  "is_default": false,
  "created_at": "2026-11-02T09:14:00Z",
  "updated_at": "2026-11-18T15:01:00Z"
}

https://api.experientiallabs.ai/api/orgs/3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10/identities/acme-support