自分の組織の一覧

GET /fapi/v1/me/organizations · 環境のサインインホストから呼び出されます

認証済みユーザーが1つのアプリケーションで切り替えられる組織を一覧表示します。対象は、ユーザーがアクティブなメンバーシップを持ち、有効な状態にあり、アプリケーションが有効になっている組織です。スラッグ順に、最大100件まで返されます。これは組織スイッチャーに表示される一覧であり、ホストされた組織ピッカーがサインイン時に提示するものと同じ一覧です。そのため、アプリケーションが使用できない組織が表示されることはありません。現在の組織としてマークされる項目はありません。アプリケーションのトークンに紐づく組織は、トークンの org_id クレームで確認します。読み取りは何も変更せず、最近検証されたセッションも必要ありません。認証済みユーザーの __Host-idp_session Cookie が必要です。Cookie がない、期限切れ、または取り消されている場合は 401 unauthenticated を返します。

@keenauth/js を使う場合: await keenauth.organizations.listMine()。

リクエスト

ヘッダー:

ヘッダー 必須 説明
Idp-Client はい SDK の識別子。

クエリパラメータ:

パラメータ 必須 説明
client_id はい 組織スイッチャーが動作する、ファーストパーティアプリケーションの client_id。

ボディはありません。

レスポンス

200 OK で {"data": [...], "truncated": false} を返します。

各項目: id(org_…。トークンの org_id クレームおよび organization パラメータと同じ形式)、slug、name(制御文字と双方向文字を除いた表示名。組織に名前がない場合はスラッグ。プレーンテキストとして表示してください)。ユーザーが一覧に含まれる以上の組織を持つ場合、truncated は true になります。

エラー

ステータス コード 発生条件
401 unauthenticated 有効なセッション Cookie がありません。
403 headless_not_allowed アプリケーションがサードパーティアプリケーションです。
422 validation_failed client_id がない、空である、255文字を超える、複数回指定されている、または不明です(/client_id)。
503 temporarily_unavailable メンバーシップディレクトリが応答しませんでした。後で再試行してください。

例

curl "https://example.keenauth.app/fapi/v1/me/organizations?client_id=app_01j9zzzzzzzzzzzzzzzzzzzz" \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt
{
  "data": [
    {
      "id": "org_01j9xxxxxxxxxxxxxxxxxxxxxx",
      "slug": "acme",
      "name": "Acme"
    }
  ],
  "truncated": false
}

個人データ

このエンドポイントは個人データを扱います。組織のメンバーシップと招待が対象です。KeenAuth API における個人データでは、保存される内容、保存期間、削除方法を説明しています。いずれのフィールドにも、特別な種類の個人データ(健康、生体情報、宗教、政治的意見、性的指向)を送信しないでください。