コンテンツにスキップ

SSO 設定を一覧表示(旧互換インターフェース)



GET /api/v1/sso/saml_list

概要

現在のワークスペースの SSO プロバイダーと関連メンバー数を読み取ります。

呼び出し前の準備と使用手順

これは旧 URL 互換インターフェースであり、現在のソースコードでも実際に登録されています。過去の「2026-05-31 廃止」というコメントは、現在リクエストが禁止されていることを意味しません。新規連携時は SSO 設定を一覧表示 を優先して使用してください。旧パスは同じコントローラー/リクエストフィールド/レスポンスを踏襲しており、saml プレフィックスを理由に OIDC が除外されることはありません。

本ワークスペースの未削除プロバイダーの配列を返します。updateAt の降順で、ページネーションは行いません。saml/oidc で絞り込めます。この公開ルートでは常にメンバー数集計が有効であり、showMemberCount を渡して上書きすることはできません。memberCount は、現在のワークスペースの有効な関係における未削除アカウントの名前空間を集計したものであり、最近のログイン数、オンライン人数、または現在のマッピングで許可されている全人数を示すものではありません。

一覧では uploadData/config を意図的に返さず、一覧から clientSecret や完全な XML を読み取ることはできません。詳細を使用してください。updatorInfo は現在利用可能なアイデンティティの概要であり、アカウント、API Key、またはシステム/AI アイデンティティの場合があります。存在しない場合は {} です。なお、email は一律にメールアドレスとして扱うことはできません。設定の status と isOpenSAMLMapping は 2 つのスイッチです。無効化された設定も一覧/get で読み取れますが、読み取れたとしても、それを使用してログインできるわけではありません。

リクエストヘッダー

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

Query リクエストパラメーター

パラメーター名 タイプ 必須 説明
type string 任意。省略した場合は未削除のすべてのタイプを取得します。空文字列は有効な絞り込み列挙値ではないため、省略することを推奨します。
null を許可: False
指定可能な値: ['saml', 'oidc']
例: oidc
取得方法または入力方法: プロバイダーの実際のプロトコルに応じて saml/oidc を選択します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/sso/saml_list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode type=oidc

レスポンス

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

フィールド タイプ 説明
content array<object> プロバイダーの配列。空の場合は []。
content[].id integer または null 現在のレコード番号。新規作成の送信前に構築した結果では null になる場合があります。
content[].uuid string sso_設定の UUID。
content[].type string saml/oidc。
content[].workspaceUUID string 所属ワークスペース。
content[].idpName string プロバイダーの表示名。
content[].remark string または null 備考。旧/新規作成の履歴では null になる場合があります。
content[].role string デフォルトのロール識別子。
content[].idpMd5 string プロバイダーのアイデンティティ/アカウント名前空間のダイジェスト。クライアントシークレットや書き込み可能な ID ではありません。
content[].tokenHoldTime integer 無操作時のセッション保持秒数。
content[].tokenMaxValidDuration integer ログインセッションの最大秒数。
content[].isOpenSAMLMapping integer または boolean ロールマッピングのスイッチ(1/0)。SSO 設定の status とは異なります。
content[].status integer 0 は有効、2 は無効。未削除の読み取りでは他の履歴状態が含まれる場合があります。
content[].creator string 作成アイデンティティ。
content[].updator string 更新アイデンティティ。
content[].createAt integer 作成日時の Unix 秒。
content[].updateAt integer 更新日時の Unix 秒。未更新の場合は -1 になることがあります。
content[].deleteAt integer 削除日時の Unix 秒。未削除の場合は -1。
content[].memberCount integer 現在のワークスペースに関連するアカウント名前空間の数。
content[].updatorInfo object 更新者アイデンティティの概要。アカウント/Key/システム/AI の場合があります。存在しない場合は {} で、フィールドはアイデンティティによって変わります。
content[].updatorInfo.uuid string 条件付きで返されます。更新アイデンティティの UUID。システムアイデンティティの場合は空文字列になることがあります。
content[].updatorInfo.name string 条件付きで返されます。表示名。
content[].updatorInfo.email string 条件付きで返されます。人間のアイデンティティの場合はメールアドレスになることがあります。API Key アイデンティティの場合は Key UUID、システム/AI アイデンティティの場合は表示ラベルであり、有効なメールアドレスとしては使用できません。
content[].updatorInfo.username string 条件付きで返されます。ログイン名。
content[].updatorInfo.status integer 条件付きで返されます。アイデンティティの状態です。アカウント/API Key/システムアイデンティティごとに解釈され、プロバイダーの status とは異なります。
content[].updatorInfo.wsAccountStatus integer 条件付きで返されます。このアイデンティティのワークスペース関係/互換状態です。アイデンティティタイプに応じて解釈され、通常のメンバー関係であるとは限りません。
content[].updatorInfo.iconUrl string 条件付きで返されます。アバター。
content[].updatorInfo.mobile string 条件付きで返されます。携帯電話番号。
content[].updatorInfo.countryCode string 条件付きで返されます。携帯電話番号の国番号。
content[].updatorInfo.acntWsNickname string 条件付きで返されます。ワークスペースのニックネーム。
content[].declaration object 空でない各オブジェクトの共通宣言。
{
  "code": 200,
  "content": [
    {
      "id": 1,
      "uuid": "sso_example",
      "type": "oidc",
      "workspaceUUID": "wksp_example",
      "idpName": "ExampleIdP",
      "remark": "企业登录",
      "role": "general",
      "idpMd5": "IDP-IDENTITY-HASH",
      "tokenHoldTime": 604800,
      "tokenMaxValidDuration": 2592000,
      "isOpenSAMLMapping": 0,
      "status": 0,
      "creator": "wsak_example",
      "updator": "wsak_example",
      "createAt": 1785427200,
      "updateAt": 1785427200,
      "deleteAt": -1,
      "memberCount": 2,
      "updatorInfo": {},
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義 を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています パラメーター解析に失敗しました パラメーターの位置、フィールド名、タイプ、値を確認してください。
500 ft.InternalServerError 設定/データベース/キーの復号、XML ツール、または関連資料のフォーマット処理で未捕捉の例外が発生しました 内部エラー traceId を保持し、現在の設定とサービス依存関係を確認してください。読み取りでは設定更新は実行されません。その失敗をプロバイダーが存在しないこととして扱わないでください。

フィードバック

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