コンテンツへ移動

管理 API

スコープ付き API キーでバックエンドから組織リソースを管理します。

Markdown で表示

認証

管理 API 呼び出しは Authorization: Bearer sk_live_* または Authorization: Bearer sk_test_* を使用します。キーは組織単位でスコープされ、各リソース操作の前に検証されます。

curl https://xid.dev/v1/users \
  -H 'Authorization: Bearer sk_live_xxx'

リソース

リソース 機能 状態
/v1/users ユーザーの作成、読み取り、更新、停止、停止解除、エクスポート、削除を行います。 実装済み
/v1/organizations 組織、ドメイン、ブランド設定、設定を管理します。 実装済み
/v1/organizations/:orgId/memberships メンバーの一覧表示、作成、ロール更新、削除を行います。 実装済み
/v1/organizations/:orgId/invitations 招待の作成(一括上限あり)、取り消し、一覧表示を行います。 実装済み
/v1/sessions ユーザーセッションの一覧表示、取得、取り消しを行います。 実装済み
/v1/applications OAuth クライアント、リダイレクト URI、グラント、トークンポリシー、シークレットを登録します。 実装済み
/v1/connections 上流エンタープライズ SSO 接続を管理します。 実装済み
/v1/directories SCIM ディレクトリを作成し、ディレクトリトークンをローテーションします。 実装済み
/v1/roles カスタムロールの作成、読み取り、更新、削除を行います。 実装済み
/v1/permissions 権限の作成、読み取り、更新、削除を行います。 実装済み
/v1/users/:userId/emailAddresses プライマリメールアドレスの追加、削除、設定を行います。 実装済み
/v1/users/:userId/phoneNumbers プライマリ電話番号の追加、削除、設定を行います。 実装済み
/v1/allowlist-identifiers 許可されたメールまたはドメイン識別子の作成、削除、一覧表示を行います。 実装済み
/v1/oauth-applications XID が ID プロバイダーとして機能する OAuth アプリケーションを管理します。 実装済み
/v1/redirect-urls 許可されたリダイレクト URL の値を登録および削除します。 実装済み
/v1/webhooks webhook エンドポイントの作成、一覧表示、更新、削除を行います。 実装済み
/v1/api-keys 組織 API キーを作成、一覧表示、取り消します。 実装済み
/v1/billing プランの確認、サブスクリプションの管理、支払い履歴の閲覧を行います。 計画中

ページネーションとエラー

一覧エンドポイントはデータ配列とカーソルメタデータを返します。エラーは安定したコード、読みやすいメッセージ、フィールド検証用の任意メタデータを含む構造化 JSON を使用します。

ナビゲーション

入力して検索...

矢印キーで移動Enter キーで選択Escape キーで閉じる