コンテンツにスキップ

SSO 設定の一覧取得



GET /api/v1/sso/list

概要

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

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

このワークスペースの削除されていないプロバイダーの配列を、updateAt の降順で返します。ページネーションは行いません。saml/oidc でフィルターできます。この公開 route ではメンバー数統計が常に有効であり、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/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 を保持し、現在の設定とサービス依存関係を確認してください。読み取りでは設定更新を実行しないため、その失敗をプロバイダーが存在しないものとして扱わないでください。

フィードバック

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