コンテンツにスキップ

SSO 設定の有効化/無効化



POST /api/v1/sso/{sso_uuid}/set_disable

概要

SSO プロバイダーのログイン設定を有効化または無効化します。

呼び出し前の注意事項と使用手順

SSO 設定の status のみを更新します。true で無効化、false で有効化し、いずれの場合も XML/OIDC/ホワイトリスト/ロールマッピングを保持します。IdP のクライアントを削除したり、そのアカウントを変更したりすることはありません。無効化後はアクティブなログイン入口として使用されなくなります。ワークスペース/メンバーのキャッシュ更新が非同期で行われるため、既存の SSO アイデンティティによる後続のアクセスが通らなくなる可能性があります。これを「新規ログインのみを阻止し、既存セッションにはまったく影響しない」と解釈しないでください。

再度有効化しても、XML、ディスカバリードキュメント、クライアント secret、デフォルトロール、またはすべてのマッピングが一致するかどうかは再検証しません。status=0 は実際のログインが復旧したことを証明しないため、テストアイデンティティで実際のフローを通して受け入れ確認する必要があります。API 自体はこのログインを実行しません。このページには needNotify パラメータがありません。コントローラーが成功するたびに、ワークスペースのオーナー/管理者への通知と監査を試みます。create/modify の通知スイッチをそのまま適用することはできません。

先に状態をコミットし、その後キャッシュタスクをディスパッチします。非同期処理が完了していない間は一時的な不整合が発生します。ディスパッチ時の例外では 500 が返る可能性がありますが、状態はすでに変更されているため、まず get で読み戻してください。メール helper は失敗を記録して握りつぶし、それを理由に状態をロールバックしません。

ルートパラメータ

パラメータ名 型 必須 説明
sso_uuid string Y 現在のプロバイダーの UUID です。fdmp_ マッピング、IdP ダイジェスト、クライアント ID ではありません。
例: sso_example
取得または入力方法: このワークスペースの SSO 一覧の content[].uuid から、削除されていない設定を取得します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報です。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
isDisable boolean Y 必須のブール値です。status=2/0 に変更します。isOpenSAMLMapping やその中のマッピング行は変更しません。
null を許可: False
例: true
取得または入力方法: true でプロバイダーを無効化し、false で有効化します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/sso/sso_example/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"isDisable":true}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content.name string 処理対象プロバイダーの表示名です。名前が空の場合は空文字列になることがあります。
content.declaration object 共通宣言。
{
  "code": 200,
  "content": {
    "name": "ExampleIdP",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーの詳細は、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反しています パラメータの解析に失敗しました パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効です リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError Body のトップレベルがオブジェクトではありません 一部の JSON ファイルの形式エラー isDisable ブール値を含むオブジェクトを送信してください。
406 ft.NotFoundSAML UUID が現在のワークスペースの削除されていない SSO 設定に属していません SSO 設定が見つかりません SSO 一覧から sso_ UUID を再取得してください。fdmp_ マッピングや idpMd5 は使用しないでください。
500 ft.InternalServerError データベース/関連データのクリーンアップ、またはコミット後のワークスペース/メンバーキャッシュタスクのディスパッチに失敗しました 内部エラー まず get/list で status と関連データを確認してください。メンバーのクリーンアップはバッチでコミット済みの可能性があります。traceId を保持し、このエラーを設定がまったく変更されていないものとして扱わないでください。

フィードバック

このページは役に立ちましたか?