組織の提案を非表示にする

POST /fapi/v1/me/organization-suggestions/{domain_id}:dismiss · 環境のサインインホストから呼び出し

自分の組織の提案を一覧表示 で得られた提案を非表示にします。件数は組織ごとに管理されます。複数のドメインが提案されている組織も、提案は 1 件として扱われます。3 回非表示にされると、その組織は提案されなくなり(hidden が true)、以降の非表示操作や参加操作は 404 not_found を返します。同時に 2 件の非表示操作があった場合は、両方がカウントされます。認証済みユーザーの __Host-idp_session Cookie が必要です。Cookie がない、期限切れ、または取り消されている場合は、401 unauthenticated を返します。別オリジンのファーストパーティアプリは、代わりにフロント API アクセストークン(DPoP 証明付きの Authorization: DPoP <token>。フロント API アクセストークン を参照)を送信できます。

@keenauth/js の場合: await keenauth.organizations.dismissSuggestion(id)。

リクエスト

ヘッダー:

ヘッダー 必須 説明
Idp-Client はい SDK の識別子です。
Origin はい https://<sign-in host> と完全に一致している必要があります。

domain_id: 提案の id(odm_…)。

ボディはありません(空の JSON オブジェクトも受け付けます)。

レスポンス

200 OK と {"dismiss_count": 1, "hidden": false} を返します。dismiss_count は 1 から 3 の間です。

エラー

ステータス コード 発生条件
401 unauthenticated 有効なセッション Cookie またはフロント API アクセストークンがありません。
403 origin_not_allowed Origin がない、または正しくありません。
404 not_found そのドメインはこのユーザーの提案ではない、または既に 3 回非表示にされています。
503 temporarily_unavailable メンバーシップディレクトリが応答しませんでした。後で再試行してください。

例

curl -X POST https://example.keenauth.app/fapi/v1/me/organization-suggestions/odm_01j9a5c4000000000000000001:dismiss \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -H "Origin: https://example.keenauth.app" \
  -b cookies.txt
{
  "dismiss_count": 1,
  "hidden": false
}

個人データ

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