DELETE /v1/sites/{siteId}/collaborators/{grantId}

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/collaborators/{grantId} \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Ends the grant. The row is kept and marked revoked rather than deleted, so the audit question survives. When it was that person's last live grant in this organisation their `site_collaborator` membership is removed too — left behind it is a dormant unrestricted membership waiting for somebody to add a second role to it. Idempotent: revoking an already-revoked grant answers `204`, not `404` or `409`. A client retrying after a dropped response must not be told it failed.

パラメータ

このエンドポイントが返すエラー

401 · 403 · 404 · 429