SSO 設定を作成(旧互換インターフェース)¶
POST /api/v1/sso/saml_create
概要¶
ワークスペースの SAML または OIDC アイデンティティプロバイダーを作成します。
呼び出し前の手順と使用手順¶
これは旧アドレスの互換インターフェースであり、現在のソースコードでも実際に登録されています。過去の「2026-05-31 廃止」というコメントは、現在リクエストが禁止されていることを示すものではありません。新規接続では SSO 設定を作成 を優先して使用してください。旧パスは同じコントローラー/リクエストフィールド/レスポンスを踏襲しており、saml プレフィックスのために OIDC が除外されることはありません。
作成前に IdP で Guance のクライアント/アプリケーションを登録し、正式なエンドポイントと本ワークスペースのデフォルトロールを確認します。SAML では実際の完全な metadata XML を送信し、OIDC では Base64 エンコードされた clientSecret と完全な設定を送信します。デフォルトでは status=0 かつ isOpenSAMLMapping=0 で作成され、成功後はプロバイダーがログイン検出に直ちに使用される可能性があります。この Body では有効化/無効化フィールドを送信しません。ロールマッピングでアクセスを制御する場合は、別途マッピングを設定して有効化します。
作成/変更では完全な SSO ログイン検収は実行されません。wellKnowURL を指定した場合は保存段階で実際の GET によるサービス検出が同期的に実行されます(保存段階ではデフォルトで TLS 検証あり)。このアドレスがない場合は、auth/token/userinfo の 3 エンドポイントを明示できます。その他の認証、code から token への交換、JWT/UserInfo のプロトコル詳細はログイン時にのみ消費されます。現在 userinfo が get 以外でも GET+Body を送信するため、POST エンドポイントの可用性は保証されません。OIDC のデフォルト scope は openid のみで、ユーザーソースは origin です。email/profile が必要な場合は IdP の権限に応じて明示し、実際にテストしてください。宣言されたフィールド型以外にも、多くの動的フィールドは保存時に厳密に検証されないため、200 が返っただけでフロー全体がログイン可能と判断できません。
IdP の識別情報(SAML entityID/ログインサービスアドレス、OIDC 認可アドレス/clientId など)を変更すると、アカウントの名前空間が変わり、メンバーのワークスペース関連付けのクリーンアップがトリガーされる可能性があります。現在のクリーンアップは新しい識別情報のダイジェストに基づいて実行され、「旧プロバイダーのユーザーだけをアンバインドする」ことは保証されません。共有メンバーの削除は、ロール/個人 Key/サブスクリプションなどの既存クリーンアップルールにも関与するため、関連メンバーと代替管理者の入口を事前に確認してください。証明書/secret のみ、または電話番号マッピングのみの更新では、その識別情報ダイジェストは必ずしも変わりません。
データベースへのコミット後、ワークスペース/メンバーのキャッシュ更新が送信され、既存の SSO アクセスが再認証される可能性があります。設定レスポンスはキャッシュがすべて更新されたことを意味しません。needNotify はデフォルト true で、ワークスペース Owner/管理者に設定通知を送信します。false はメールのみを抑制し、監査/キャッシュは引き続き実行されます。メール送信失敗は記録されますが、設定はロールバックされません。変更レスポンスに emails が必ず含まれるわけではないため、再度 get でホワイトリストを検収してください。書き込みレスポンスの secret は保存暗号文であり、詳細 get でのみ保持に使用できるアスタリスクマスクが返されます。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| emailDomains[*] | string | 空でない文字列を推奨します。公開配列はメール形式を項目ごとに厳密検証しておらず、不正なオブジェクト/ネスト配列は 500 になる可能性があります。長さはストレージの 256 で制御されます。 例: example.com取得または入力方法: 実際の単一メールアドレス/ドメイン識別子を使用し、アイデンティティソースが返す email と一致させます。 |
|
| config.modeType | string | easy/expert を選択可能。デフォルトは easy です。このフィールドは主に編集モードを保持するもので、任意のエキスパート設定が実行可能であると自動検証するものではありません。 例: expert取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.wellKnowURL | string | 任意の HTTP(S) 検出アドレス。指定時は保存段階で実際に GET して JSON を解析します(オフライン検証ではありません)。リクエスト失敗/SSL/HTTP エラーは本ページのエラーになります。省略する場合は auth/token/userinfo の 3 エンドポイントを明示する必要があり、modeType=expert だけを書くことはできません。 例: https://idp.example.com/.well-known/openid-configuration取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.sslVerify | boolean | 検出リクエストの TLS 検証スイッチ。保存段階のデフォルトは true です。実行時 SDK は HTTPS ではデフォルト true、HTTP ではデフォルト false であり、各エンドポイントの verify を統一するマスタースイッチとして扱いません。 例: true取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.clientId | string | OIDC では必須の空でない文字列で、前後に空白を含めることはできません。IdP のクライアント登録から取得するもので、Studio API Key ではありません。 例: client_example取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.clientSecret | string | OIDC クライアントシークレットの UTF-8 平文をまず Base64 にします(例はプレースホルダー平文のエンコードであり、実際の secret ではありません)。作成時はデコード後に空でなく、すべてアスタリスクであってはなりません。Base64 は暗号化転送と同義ではないため、HTTPS を使用する必要があります。非空の config を変更する場合は旧 secret を保持し、get が返す Base64 のアスタリスクマスクを使用します。省略/空文字列は後続の設定検証で拒否されるため、保持指示ではありません。create/modify レスポンスの保存暗号文を返送しないでください。 例: U0VDUkVULVBMQUNFSE9MREVS取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.grantType | string | authorization_code/code を選択可能。省略時の実行デフォルトは authorization_code です。client_credentials や password 認可ではありません。 例: authorization_code取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.scope | array | 任意の文字列配列。実行時 SDK のデフォルトは [openid] のみで、旧説明の openid/profile/email ではありません。IdP がアカウントに必要な email などのクレームを実際に提供することを確認してください。空配列は空の scope を生成するため、クライアントは明示的かつ適切に設定する必要があります。 例: ["openid", "profile", "email"]取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.scope[*] | string | IdP が許可する単一の scope です。本ワークスペースの権限ポイントではありません。 例: email取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.authSet | json | 認可リダイレクトパラメータオブジェクト。省略すると検出ドキュメントからアドレスを補完できます。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet | json | code を token に交換するリクエストオブジェクト。省略するとエンドポイントを検出ドキュメントから取得します。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet | json | id_token の署名検証用 JWK オブジェクトです。設定保存のために直ちに token 認証を開始するものではありません。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet | json | ユーザー情報のソース/リクエストオブジェクト。デフォルトは origin で、旧説明のデフォルト id_token ではありません。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.claimMapping | json | アカウントフィールドから IdP の実際の属性名へのマッピングであり、ロールマッピングルールではありません。OIDC の保存では項目ごとの厳密検証がないため、実際にコールバックをテストする必要があります。SAML の非空マッピングでは非空の username/email を同時に指定する必要があり、mobile は任意の文字列です。空オブジェクトは旧デフォルトと互換です。 例: {"username": "preferred_username", "email": "email", "mobile": "phone_number"}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.authSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの authorization_endpoint を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 例: https://idp.example.com/authorize取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.authSet.paramMapping | json | 任意の非標準リクエストパラメータマッピング。非空の場合は対応するデフォルトパラメータ集合を置き換えるため、必須項目を完全に保持する必要があります。キーは IdP のパラメータ名で、値は本ページで許可される $ 変数または固定文字列です。clientSecret を認可リダイレクト URL にマッピングしないでください。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.authSet.paramMapping.目标参数名 | string | 動的な IdP パラメータ値。許可される変数の範囲は段階によって異なり、下表を参照してください。未知の文字列は定数として保持され、任意の内部コンテキストから自動取得されません。 例: $client_id取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの token_endpoint を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 例: https://idp.example.com/token取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet.verify | boolean | 任意。このエンドポイントは HTTPS ではデフォルト true、HTTP ではデフォルト false です。個別に設定するもので、sslVerify で一律に代替されません。 例: true取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet.paramMapping | json | 任意の非標準リクエストパラメータマッピング。非空の場合は対応するデフォルトパラメータ集合を置き換えるため、必須項目を完全に保持する必要があります。キーは IdP のパラメータ名で、値は本ページで許可される $ 変数または固定文字列です。clientSecret を認可リダイレクト URL にマッピングしないでください。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet.paramMapping.目标参数名 | string | 動的な IdP パラメータ値。許可される変数の範囲は段階によって異なり、下表を参照してください。未知の文字列は定数として保持され、任意の内部コンテキストから自動取得されません。 例: $client_id取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの jwks_uri を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 例: https://idp.example.com/jwks取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.verify | boolean | 任意。このエンドポイントは HTTPS ではデフォルト true、HTTP ではデフォルト false です。個別に設定するもので、sslVerify で一律に代替されません。 例: true取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの userinfo_endpoint を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 例: https://idp.example.com/userinfo取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.verify | boolean | 任意。このエンドポイントは HTTPS ではデフォルト true、HTTP ではデフォルト false です。個別に設定するもので、sslVerify で一律に代替されません。 例: true取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.paramMapping | json | 任意の非標準リクエストパラメータマッピング。非空の場合は対応するデフォルトパラメータ集合を置き換えるため、必須項目を完全に保持する必要があります。キーは IdP のパラメータ名で、値は本ページで許可される $ 変数または固定文字列です。clientSecret を認可リダイレクト URL にマッピングしないでください。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.paramMapping.目标参数名 | string | 動的な IdP パラメータ値。許可される変数の範囲は段階によって異なり、下表を参照してください。未知の文字列は定数として保持され、任意の内部コンテキストから自動取得されません。 例: $client_id取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet.method | string | get/post を選択可能。デフォルトは post で、実行時はこの 2 つのみをサポートします。保存時にこの列挙を強制しないため、他の値は後続のログイン時にエラーになります。 例: post取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getTokenSet.authMethod | string | basic/client_secret_basic(デフォルトは Basic ヘッダー)、client_secret_post(デフォルトは ID と secret をフォームに含める)、none(デフォルトは client_id のみで secret を自動的に含めない)を選択可能。カスタム paramMapping がある場合は完全なマッピングに従ってパラメータを生成し、Basic ヘッダーは選択した認証方式に従います。 例: client_secret_basic取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.method | string | デフォルトは get です。現在の SDK では非 get 分岐でも GET を送信しますが、パラメータは Body に置くため、真の POST ではありません。POST が必要な IdP は保存成功だけでサポートと判断せず、検証済みの GET エンドポイントを使用することを推奨します。 例: get取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.authMethod | string | デフォルトは bearer ヘッダーです。client_secret_basic は Basic ヘッダーを使用し、none はデフォルトで access_token をパラメータに含めます。basic の別名やその他の任意の値を同じように有効とはみなしません。 例: bearer取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.source | string | origin は userinfo を呼び出します(デフォルト)。id_token は id_token を検証して読み取ります。merge は先に id_token を取得し、次に userinfo で同名キーを上書きします。保存時に列挙を強制しないため、他の値では最終的にユーザー情報が得られない可能性があります。 例: origin取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.getUserInfoSet.responseInfoPath | string | 任意。レスポンス内のユーザーオブジェクトへのドットパスで、origin の結果からのみ抽出します。空文字列はレスポンス全体を取得し、claimMapping の属性名とは異なります。 例: data.user取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.keys | array | 任意の IdP 公開 JWK 配列。非空の場合は直接署名検証に使用し、それ以外の場合は実行時に verifyTokenSet.url を GET して keys を取得します。秘密鍵ではなく、例のプレースホルダー素材を実際の署名検証設定として扱わないでください。 例: []取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.keys[*] | json | 単一の公開 JWK。IdP が公開する kty/alg/kid および公開鍵パラメータに従って完全な構造を保持します。 例: {}取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.keys[*].kty | string | 公開鍵の種類(RSA/EC など)。IdP の JWK に従います。 例: RSA取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].kid | string | 公開鍵の選択に使用する識別子。 例: KEY-ID取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].use | string | 鍵の用途。 例: sig取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].alg | string | 署名検証アルゴリズムの識別子。 例: RS256取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].n | string | RSA モジュラスの Base64url。 例: PUBLIC-MODULUS取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].e | string | RSA 公開指数の Base64url。 例: AQAB取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].crv | string | EC 曲線。該当する種類のみです。 例: P-256取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].x | string | EC 公開 x 座標。 例: PUBLIC-X取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].y | string | EC 公開 y 座標。 例: PUBLIC-Y取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].x5c | array | 公開証明書チェーンの Base64 DER 配列(任意)。 例: ["PUBLIC-CERTIFICATE"]取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].x5c[*] | string | 単一の公開証明書。秘密鍵は含みません。 例: PUBLIC-CERTIFICATE取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.verifyTokenSet.keys[*].其他公开字段 | JSON | IdP JWK の拡張はライブラリのプロトコルに従って保持し、d/p/q などの秘密鍵素材を追加しません。 例: VALUE取得または入力方法: IdP の正式な JWKS から完全な公開値を取得し、手作業で推測・作成しません。 |
|
| config.claimMapping.username | string | OIDC のデフォルトは preferred_username、SAML のデフォルトは username です。SAML で明示的に非空の claimMapping を指定する場合は、非空文字列が必須です。 例: preferred_username取得または入力方法: IdP 管理者から実際の属性名を提供してもらいます。フィールドマッピングは電話番号/email を固定値として書き込むものではありません。 |
|
| config.claimMapping.email | string | デフォルトは email で、実際のログインでは有効なメールアドレスを取得する必要があります。SAML で明示的に非空の claimMapping を指定する場合は必須です。OIDC の保存では値/ソースを検証しませんが、コールバックでは引き続きメールアドレスが必要です。 例: email取得または入力方法: IdP 管理者から実際の属性名を提供してもらいます。フィールドマッピングは電話番号/email を固定値として書き込むものではありません。 |
|
| config.claimMapping.name | string | OIDC の任意の表示名属性で、デフォルトは name です。SAML は現在 name を固定で読み取り、このマッピングキーで表示名の抽出方法は変わりません。 例: name取得または入力方法: IdP 管理者から実際の属性名を提供してもらいます。フィールドマッピングは電話番号/email を固定値として書き込むものではありません。 |
|
| config.claimMapping.mobile | string | OIDC のデフォルトは phone_number、SAML のデフォルトは mobile で、明示的な空文字列では抽出しません。番号がない場合は補完せず、既存の電話番号および市外局番は保持し、元のアカウントに番号がなく IdP の番号が有効な場合にのみ補完します。 例: phone_number取得または入力方法: IdP 管理者から実際の属性名を提供してもらいます。フィールドマッピングは電話番号/email を固定値として書き込むものではありません。 |
|
| config.authSet.verify | boolean | 既存との互換のため保存できますが、現在の OIDC SDK はこのキーを消費しないため、これでリクエスト/TLS を制御することはできません。本ページで実際に読み取る対応フィールドを使用してください。 例: true取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.method | string | 既存との互換のため保存できますが、現在の OIDC SDK はこのキーを消費しないため、これでリクエスト/TLS を制御することはできません。本ページで実際に読み取る対応フィールドを使用してください。 例: get取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config.verifyTokenSet.authMethod | string | 既存との互換のため保存できますが、現在の OIDC SDK はこのキーを消費しないため、これでリクエスト/TLS を制御することはできません。本ページで実際に読み取る対応フィールドを使用してください。 例: get取得または入力方法: アイデンティティプロバイダーが現在のクライアントに割り当てた正式な OIDC 設定および実際のプロトコルドキュメントから取得します。 |
|
| config | json | 動的な完全設定オブジェクトで、OIDC 作成の業務では必須です。変更時に省略または {} の場合は旧 config を保持します。非空オブジェクトは全体置換であり、再帰マージではないため、OIDC では clientId/clientSecret/有効な URL などを返送する必要があります。SAML では idpData を省略して非空の config のみを送信できません。内部フィールド型はすべて強制検証されていないため、保存成功はコールバックが利用可能であることを証明しません。 null を許可: False 例: {}取得または入力方法: OIDC はプロバイダーの client/検出ドキュメントとプロトコルパラメータから構築します。SAML は任意の claimMapping にのみ使用します。 |
|
| emailDomains | array | Y | 必須配列で、[] も可能です。サーバー側の set で重複排除されます。URL、正規表現、@ 付きワイルドカードではありません。初回入口の検出は完全なメールアドレスまたはドメインの等値一致で行い、既存の SSO 識別情報には別途名前空間/ワークスペース関係のルールがあるため、汎用アクセス制御の代替にはできません。変更時はホワイトリスト全体を置換し、[] でクリアします。 例: ["example.com"]取得または入力方法: このプロバイダーの検出を許可する完全なメールアドレスまたはメールドメイン(user@guance.com や example.com など)を使用します。 |
| idpData | string | SAML 作成の業務では必須で、entityID、SSO サービスアドレス、鍵の説明を含める必要があります。変更時に省略/空文字列の場合は旧 XML を保持します。SAML で非空の config を送信する場合は、有効な XML も同時に返送する必要があります。OIDC では送信しないでください。OIDC で idpData のみが変更され config がない場合、識別情報ダイジェストが None になり 500 になる可能性があります。 null を許可: False 例: <IdP_METADATA_XML>取得または入力方法: SAML アイデンティティプロバイダー管理者から完全で有効な IdP metadata XML をダウンロードし、元の文字列のまま送信します。 |
|
| idpName | string | Y | 必須、64 文字以下。宣言正規表現は [a-zA-Z_一-龥-]* です。英字/中国語/アンダースコア/ハイフンのみを使用し、数字/空白は使用しないことを推奨します。現在の正規表現は完全にアンカーされておらず、任意の末尾文字が確実に拒否されることを意味しません。同一ワークスペース内で削除されていないプロバイダー名は重複できません。変更時は非空の場合のみ旧名を上書きします。 $matchRegExp: [a-zA-Z_一-龥-]* 最大長: 64 例: ExampleIdP取得または入力方法: 業務上、現在のワークスペースのアイデンティティプロバイダーを区別する名前です。 |
| needNotify | boolean | 作成/変更時に任意で、デフォルトは true です。false は設定リマインダーメールのみを抑制し、設定保存、キャッシュ更新、監査を妨げません。SSO の無効化やユーザーログインの禁止ではありません。 null を許可: False 例: false取得または入力方法: ワークスペース Owner/管理者に設定変更を通知するかどうか。一括リハーサルではフローに応じて明示的に false にできます。 |
|
| remark | string | 任意で空文字列を許可。作成時に省略すると構築レスポンスが null になる場合があり、データベース列には空文字列のデフォルトがあります。明示的な空文字列または有効なテキストを推奨します。変更時に省略すると "" にクリアされ、保持されません。ストレージ列は 512 で、公開上の統一上限は宣言されていません。 空文字列を許可: True null を許可: False 例: 企业登录取得または入力方法: 業務担当者が用途の備考を入力します。 |
|
| role | string | Y | 必須。general/readOnly または本ワークスペースで表示されるアクティブなカスタムロール。owner/wsAdmin は禁止です。マッピング無効時は新しいロール関係の作成に使用され、既存メンバーのすべての旧ロールを強制的に上書きすることは保証されません。ロールマッピング有効時はマッピングの一致に従ってアクセスを決定します。 空文字列を許可: False null を許可: False 例: general取得または入力方法: 本ワークスペースのロール一覧からデフォルトのログインロールを選択します。 |
| tokenHoldTime | integer | 任意、60..604800 秒。作成時に省略するとサイトデフォルト(リポジトリ基準 604800=7 日)、変更時に省略すると旧値を保持します。キャッシュ code の有効期限ではなく、この値でワンタイム認証 code の消費ウィンドウを拡大するものではありません。 null を許可: False $maxValue: 604800 $minValue: 60 例: 604800取得または入力方法: 組織の無操作セッション保持ポリシーに応じて秒数を選択します。 |
|
| tokenMaxValidDuration | integer | 任意、60..2592000 秒。作成時に省略するとサイトデフォルト(リポジトリ基準 2592000=30 日)、変更時に省略すると保持します。旧説明の「30 日=604800」は正しくありません。無操作保持時間を代替するものではありません。 null を許可: False $maxValue: 2592000 $minValue: 60 例: 2592000取得または入力方法: 組織のログインセッション最大寿命に応じて秒数を選択します。 |
|
| type | string | Y | 作成時必須。変更時は型が元の設定を踏襲し、type を受け取ってプロトコルを変更しません。 null を許可: False 選択可能な値: ['saml', 'oidc'] 例: oidc取得または入力方法: アイデンティティプロバイダーのプロトコルに応じて saml または oidc を選択します。 |
パラメータ補足説明¶
OIDC カスタムパラメータマッピングは段階ごとに使用します:
| 段階 | サポートされる変数値 |
|---|---|
| authSet | $state、$client_id、$client_secret、$redirect_uri、$scope、$response_type(code)、$grant_type。secret をブラウザ URL に含めないでください |
| getTokenSet | $state、$code、$client_id、$client_secret、$redirect_uri、$scope、$grant_type。他のキーがコールバックパラメータ名と一致する場合はその値を取得でき、それ以外は固定テキストとして扱われます |
| getUserInfoSet | $client_id、$client_secret、$redirect_uri、$scope、$access_token |
マッピングオブジェクトが非空の場合はデフォルトのリクエストパラメータを置き換え、不足している redirect_uri/code/scope などの必須項目を自動補完しません。保存では一部の URL/client フィールドのみを検証し、完全な認証フローは実行しません。専用のテストアイデンティティで実際のコールバックと最終的なワークスペースアクセスを検収する必要があります。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/sso/saml_create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"emailDomains":["example.com"],"idpName":"ExampleIdP","role":"general","remark":"企业登录","config":{"modeType":"expert","clientId":"client_example","clientSecret":"U0VDUkVULVBMQUNFSE9MREVS","scope":["openid","profile","email"],"grantType":"authorization_code","authSet":{"url":"https://idp.example.com/authorize"},"getTokenSet":{"url":"https://idp.example.com/token","method":"post","authMethod":"client_secret_basic"},"verifyTokenSet":{"url":"https://idp.example.com/jwks"},"getUserInfoSet":{"url":"https://idp.example.com/userinfo","method":"get","authMethod":"bearer","source":"origin"},"claimMapping":{"username":"preferred_username","email":"email","mobile":"phone_number"}},"tokenHoldTime":604800,"tokenMaxValidDuration":2592000,"needNotify":false,"type":"oidc"}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| 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.uploadData | string | SAML で保存された完全な IdP metadata XML。OIDC では通常は空文字列です。 |
| content.config | object | 保存後の完全な設定。OIDC の書き込みレスポンスには引き続き保存暗号文が含まれ、get の Base64 アスタリスクマスクではないため、これで直接認証したり返送したりできません。 |
| content.config.modeType | string | easy/expert を選択可能。デフォルトは easy です。このフィールドは主に編集モードを保持するもので、任意のエキスパート設定が実行可能であると自動検証するものではありません。 |
| content.config.wellKnowURL | string | 任意の HTTP(S) 検出アドレス。指定時は保存段階で実際に GET して JSON を解析します(オフライン検証ではありません)。リクエスト失敗/SSL/HTTP エラーは本ページのエラーになります。省略する場合は auth/token/userinfo の 3 エンドポイントを明示する必要があり、modeType=expert だけを書くことはできません。 |
| content.config.sslVerify | boolean | 検出リクエストの TLS 検証スイッチ。保存段階のデフォルトは true です。実行時 SDK は HTTPS ではデフォルト true、HTTP ではデフォルト false であり、各エンドポイントの verify を統一するマスタースイッチとして扱いません。 |
| content.config.clientId | string | OIDC では必須の空でない文字列で、前後に空白を含めることはできません。IdP のクライアント登録から取得するもので、Studio API Key ではありません。 |
| content.config.clientSecret | string | OIDC の書き込みレスポンスではサーバー側の保存暗号文であり、Base64 平文/マスクとして返送できません。secret を保持して変更する場合は、先に get を呼び出してマスクを取得します。 |
| content.config.grantType | string | authorization_code/code を選択可能。省略時の実行デフォルトは authorization_code です。client_credentials や password 認可ではありません。 |
| content.config.scope | array | 任意の文字列配列。実行時 SDK のデフォルトは [openid] のみで、旧説明の openid/profile/email ではありません。IdP がアカウントに必要な email などのクレームを実際に提供することを確認してください。空配列は空の scope を生成するため、クライアントは明示的かつ適切に設定する必要があります。 |
| content.config.scope[] | string | IdP が許可する単一の scope です。本ワークスペースの権限ポイントではありません。 |
| content.config.authSet | json | 認可リダイレクトパラメータオブジェクト。省略すると検出ドキュメントからアドレスを補完できます。 |
| content.config.getTokenSet | json | code を token に交換するリクエストオブジェクト。省略するとエンドポイントを検出ドキュメントから取得します。 |
| content.config.verifyTokenSet | json | id_token の署名検証用 JWK オブジェクトです。設定保存のために直ちに token 認証を開始するものではありません。 |
| content.config.getUserInfoSet | json | ユーザー情報のソース/リクエストオブジェクト。デフォルトは origin で、旧説明のデフォルト id_token ではありません。 |
| content.config.claimMapping | json | アカウントフィールドから IdP の実際の属性名へのマッピングであり、ロールマッピングルールではありません。OIDC の保存では項目ごとの厳密検証がないため、実際にコールバックをテストする必要があります。SAML の非空マッピングでは非空の username/email を同時に指定する必要があり、mobile は任意の文字列です。空オブジェクトは旧デフォルトと互換です。 |
| content.config.authSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの authorization_endpoint を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 |
| content.config.authSet.paramMapping | json | 任意の非標準リクエストパラメータマッピング。非空の場合は対応するデフォルトパラメータ集合を置き換えるため、必須項目を完全に保持する必要があります。キーは IdP のパラメータ名で、値は本ページで許可される $ 変数または固定文字列です。clientSecret を認可リダイレクト URL にマッピングしないでください。 |
| content.config.authSet.paramMapping.目标参数名 | string | 動的な IdP パラメータ値。許可される変数の範囲は段階によって異なり、下表を参照してください。未知の文字列は定数として保持され、任意の内部コンテキストから自動取得されません。 |
| content.config.getTokenSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの token_endpoint を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 |
| content.config.getTokenSet.verify | boolean | 任意。このエンドポイントは HTTPS ではデフォルト true、HTTP ではデフォルト false です。個別に設定するもので、sslVerify で一律に代替されません。 |
| content.config.getTokenSet.paramMapping | json | 任意の非標準リクエストパラメータマッピング。非空の場合は対応するデフォルトパラメータ集合を置き換えるため、必須項目を完全に保持する必要があります。キーは IdP のパラメータ名で、値は本ページで許可される $ 変数または固定文字列です。clientSecret を認可リダイレクト URL にマッピングしないでください。 |
| content.config.getTokenSet.paramMapping.目标参数名 | string | 動的な IdP パラメータ値。許可される変数の範囲は段階によって異なり、下表を参照してください。未知の文字列は定数として保持され、任意の内部コンテキストから自動取得されません。 |
| content.config.verifyTokenSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの jwks_uri を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 |
| content.config.verifyTokenSet.verify | boolean | 任意。このエンドポイントは HTTPS ではデフォルト true、HTTP ではデフォルト false です。個別に設定するもので、sslVerify で一律に代替されません。 |
| content.config.getUserInfoSet.url | string | 任意の明示的な HTTP(S) URL。指定しない場合は検出ドキュメントの userinfo_endpoint を取得し、値がある場合は実行時エンドポイントを上書きします。検出ドキュメントがない場合は auth/token/userinfo の 3 つが必須で、署名検証元は別途 JWK が利用可能であることを確保してください。 |
| content.config.getUserInfoSet.verify | boolean | 任意。このエンドポイントは HTTPS ではデフォルト true、HTTP ではデフォルト false です。個別に設定するもので、sslVerify で一律に代替されません。 |
| content.config.getUserInfoSet.paramMapping | json | 任意の非標準リクエストパラメータマッピング。非空の場合は対応するデフォルトパラメータ集合を置き換えるため、必須項目を完全に保持する必要があります。キーは IdP のパラメータ名で、値は本ページで許可される $ 変数または固定文字列です。clientSecret を認可リダイレクト URL にマッピングしないでください。 |
| content.config.getUserInfoSet.paramMapping.目标参数名 | string | 動的な IdP パラメータ値。許可される変数の範囲は段階によって異なり、下表を参照してください。未知の文字列は定数として保持され、任意の内部コンテキストから自動取得されません。 |
| content.config.getTokenSet.method | string | get/post を選択可能。デフォルトは post で、実行時はこの 2 つのみをサポートします。保存時にこの列挙を強制しないため、他の値は後続のログイン時にエラーになります。 |
| content.config.getTokenSet.authMethod | string | basic/client_secret_basic(デフォルトは Basic ヘッダー)、client_secret_post(デフォルトは ID と secret をフォームに含める)、none(デフォルトは client_id のみで secret を自動的に含めない)を選択可能。カスタム paramMapping がある場合は完全なマッピングに従ってパラメータを生成し、Basic ヘッダーは選択した認証方式に従います。 |
| content.config.getUserInfoSet.method | string | デフォルトは get です。現在の SDK では非 get 分岐でも GET を送信しますが、パラメータは Body に置くため、真の POST ではありません。POST が必要な IdP は保存成功だけでサポートと判断せず、検証済みの GET エンドポイントを使用することを推奨します。 |
| content.config.getUserInfoSet.authMethod | string | デフォルトは bearer ヘッダーです。client_secret_basic は Basic ヘッダーを使用し、none はデフォルトで access_token をパラメータに含めます。basic の別名やその他の任意の値を同じように有効とはみなしません。 |
| content.config.getUserInfoSet.source | string | origin は userinfo を呼び出します(デフォルト)。id_token は id_token を検証して読み取ります。merge は先に id_token を取得し、次に userinfo で同名キーを上書きします。保存時に列挙を強制しないため、他の値では最終的にユーザー情報が得られない可能性があります。 |
| content.config.getUserInfoSet.responseInfoPath | string | 任意。レスポンス内のユーザーオブジェクトへのドットパスで、origin の結果からのみ抽出します。空文字列はレスポンス全体を取得し、claimMapping の属性名とは異なります。 |
| content.config.verifyTokenSet.keys | array | 任意の IdP 公開 JWK 配列。非空の場合は直接署名検証に使用し、それ以外の場合は実行時に verifyTokenSet.url を GET して keys を取得します。秘密鍵ではなく、例のプレースホルダー素材を実際の署名検証設定として扱わないでください。 |
| content.config.verifyTokenSet.keys[] | json | 単一の公開 JWK。IdP が公開する kty/alg/kid および公開鍵パラメータに従って完全な構造を保持します。 |
| content.config.verifyTokenSet.keys[].kty | string | 公開鍵の種類(RSA/EC など)。IdP の JWK に従います。 |
| content.config.verifyTokenSet.keys[].kid | string | 公開鍵の選択に使用する識別子。 |
| content.config.verifyTokenSet.keys[].use | string | 鍵の用途。 |
| content.config.verifyTokenSet.keys[].alg | string | 署名検証アルゴリズムの識別子。 |
| content.config.verifyTokenSet.keys[].n | string | RSA モジュラスの Base64url。 |
| content.config.verifyTokenSet.keys[].e | string | RSA 公開指数の Base64url。 |
| content.config.verifyTokenSet.keys[].crv | string | EC 曲線。該当する種類のみです。 |
| content.config.verifyTokenSet.keys[].x | string | EC 公開 x 座標。 |
| content.config.verifyTokenSet.keys[].y | string | EC 公開 y 座標。 |
| content.config.verifyTokenSet.keys[].x5c | array | 公開証明書チェーンの Base64 DER 配列(任意)。 |
| content.config.verifyTokenSet.keys[].x5c[] | string | 単一の公開証明書。秘密鍵は含みません。 |
| content.config.verifyTokenSet.keys[].其他公开字段 | JSON | IdP JWK の拡張はライブラリのプロトコルに従って保持し、d/p/q などの秘密鍵素材を追加しません。 |
| content.config.claimMapping.username | string | OIDC のデフォルトは preferred_username、SAML のデフォルトは username です。SAML で明示的に非空の claimMapping を指定する場合は、非空文字列が必須です。 |
| content.config.claimMapping.email | string | デフォルトは email で、実際のログインでは有効なメールアドレスを取得する必要があります。SAML で明示的に非空の claimMapping を指定する場合は必須です。OIDC の保存では値/ソースを検証しませんが、コールバックでは引き続きメールアドレスが必要です。 |
| content.config.claimMapping.name | string | OIDC の任意の表示名属性で、デフォルトは name です。SAML は現在 name を固定で読み取り、このマッピングキーで表示名の抽出方法は変わりません。 |
| content.config.claimMapping.mobile | string | OIDC のデフォルトは phone_number、SAML のデフォルトは mobile で、明示的な空文字列では抽出しません。番号がない場合は補完せず、既存の電話番号および市外局番は保持し、元のアカウントに番号がなく IdP の番号が有効な場合にのみ補完します。 |
| content.config.authSet.verify | boolean | 既存との互換のため保存できますが、現在の OIDC SDK はこのキーを消費しないため、これでリクエスト/TLS を制御することはできません。本ページで実際に読み取る対応フィールドを使用してください。 |
| content.config.verifyTokenSet.method | string | 既存との互換のため保存できますが、現在の OIDC SDK はこのキーを消費しないため、これでリクエスト/TLS を制御することはできません。本ページで実際に読み取る対応フィールドを使用してください。 |
| content.config.verifyTokenSet.authMethod | string | 既存との互換のため保存できますが、現在の OIDC SDK はこのキーを消費しないため、これでリクエスト/TLS を制御することはできません。本ページで実際に読み取る対応フィールドを使用してください。 |
| content.loginURL | string | このプロバイダーのログイン入口で、デプロイサイトが返します。DF-API-KEY でアクセスする現在の OpenAPI パスではありません。 |
| content.callbackURL | string | OIDC コールバック URL のみ。IdP の許可済みコールバックリストに登録する必要があります。 |
| content.metadataURL | string | SAML SP metadata アドレスのみ。 |
| content.entiryID | string | SAML SP entity ID のみ。プロトコル上の実際のつづり entiryID を保持し、entityID に変更しません。 |
| content.assertionURL | string | SAML ACS/assertion コールバックアドレスのみ。実際に返された値に従って登録します。 |
| content.emails | array<string> | 作成後に重複排除されたホワイトリスト値の配列。 |
| content.emails[] | string | 完全なメールアドレスまたはドメイン値。 |
| content.declaration | object | 外側の共通宣言。 |
{
"code": 200,
"content": {
"id": null,
"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,
"config": {
"modeType": "expert",
"clientId": "client_example",
"clientSecret": "STORED-CIPHERTEXT-PLACEHOLDER",
"scope": [
"openid",
"profile",
"email"
],
"grantType": "authorization_code",
"authSet": {
"url": "https://idp.example.com/authorize"
},
"getTokenSet": {
"url": "https://idp.example.com/token",
"method": "post",
"authMethod": "client_secret_basic"
},
"verifyTokenSet": {
"url": "https://idp.example.com/jwks"
},
"getUserInfoSet": {
"url": "https://idp.example.com/userinfo",
"method": "get",
"authMethod": "bearer",
"source": "origin"
},
"claimMapping": {
"username": "preferred_username",
"email": "email",
"mobile": "phone_number"
}
},
"uploadData": "",
"loginURL": "https://sso.example.com/oidc/login/sso_example",
"callbackURL": "https://sso.example.com/oidc/callback/sso_example",
"declaration": {},
"emails": [
"example.com"
]
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
SAML リクエスト例:まず <IdP_METADATA_XML> を管理者から提供された完全で有効な XML に置き換えます(このプレースホルダーテキストのまま保存することはできません)。変更対象は元々 SAML である必要があります。
curl --request POST '<Endpoint>/api/v1/sso/saml_create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"emailDomains":["example.com"],"idpName":"ExampleSAML","role":"general","remark":"SAML登录","idpData":"<IdP_METADATA_XML>","config":{"claimMapping":{"username":"uid","email":"mail","mobile":"telephone"}},"needNotify":false,"type":"saml"}'
OIDC 設定成功レスポンス例(secret は保存暗号文のプレースホルダーであり、返送できません):
{
"code": 200,
"content": {
"id": null,
"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,
"config": {
"modeType": "expert",
"clientId": "client_example",
"clientSecret": "STORED-CIPHERTEXT-PLACEHOLDER",
"scope": [
"openid",
"profile",
"email"
],
"grantType": "authorization_code",
"authSet": {
"url": "https://idp.example.com/authorize"
},
"getTokenSet": {
"url": "https://idp.example.com/token",
"method": "post",
"authMethod": "client_secret_basic"
},
"verifyTokenSet": {
"url": "https://idp.example.com/jwks"
},
"getUserInfoSet": {
"url": "https://idp.example.com/userinfo",
"method": "get",
"authMethod": "bearer",
"source": "origin"
},
"claimMapping": {
"username": "preferred_username",
"email": "email",
"mobile": "phone_number"
}
},
"uploadData": "",
"loginURL": "https://sso.example.com/oidc/login/sso_example",
"callbackURL": "https://sso.example.com/oidc/callback/sso_example",
"declaration": {},
"emails": [
"example.com"
]
},
"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 オブジェクトではない | 一部の json ファイル形式エラー | 本ページのフィールドを含む完全なオブジェクトを送信します。 |
| 406 | ft.ParameterValidationFailed | SAML claimMapping の構造が無効、または宣言されたフィールド型/列挙/範囲が一致しない | パラメータ解析に失敗しました | 非空の SAML マッピングでは非空の username/email を同時に指定し、mobile は文字列である必要があります。公開パラメータ表に従って修正します。 |
| 400 | ft.InvalidSsoRoleCfg | デフォルトロールが owner/wsAdmin | 管理者、所有者ロールの設定はサポートされていません | general/readOnly または本ワークスペースのアクティブなカスタムロールに変更します。 |
| 400 | ft.InvalidCustomRole | デフォルトのカスタムロールが存在しない、無効化/削除済み、または現在のワークスペースの表示範囲にない | 無効なカスタムロール | 現在のワークスペースのロール一覧から有効なロールを取得し、表示名を使用しません。 |
| 406 | ft.InvalidOIDC | OIDC 作成時に非空の config がない | 無効な OIDC 設定 | 完全なクライアントとエンドポイント設定を送信します。 |
| 406 | ft.InvalidSAML | SAML に有効な XML がない、metadata にエンティティ/サービス/鍵の説明がない、または非空の config を変更して有効な idpData を返送していない | 無効な saml 設定 | IdP から実際の完全な metadata XML をダウンロードします。フィールドマッピングを更新する場合は元の有効な XML も同時に返送します。 |
| 400 | ft.SsoModeTypeInvalid | OIDC の modeType が easy/expert ではない | modeType パラメータが無効です | 本ページの列挙に従って選択します。 |
| 400 | ft.SsoClientIdInvalid | clientId が空/文字列以外、または前後に空白がある | clientId パラメータが無効です | IdP が割り当てた元のクライアント ID を使用します。 |
| 400 | ft.SsoClientSecretInvalid | clientSecret が有効な Base64 UTF-8 ではない、作成時にデコード後が空/すべてアスタリスク、または非空の config 内に有効な clientSecret 文字列がない | clientSecret パラメータが無効です | 作成時は実際の secret をエンコードして使用します。変更時に旧値を保持する場合は get が返す Base64 アスタリスクマスクを使用し、保存暗号文を返送しません。 |
| 400 | ft.SsoSSLVerifyInvalid | 保存時に検出ドキュメントリクエストの SSL 検証が失敗 | SSL 検証例外: {} | 証明書チェーン/ドメインと信頼関係を確認し、組織のポリシーに応じて sslVerify を設定します。 |
| 400 | ft.SsoWellKnowURLInvalid | wellKnowURL が有効な HTTP(S) アドレスではない、または検出リクエストの HTTP が 400 以上 | アイデンティティプロバイダー URL(wellKnowURL)パラメータが無効です | 正式な検出アドレスとサービス応答を確認します。ログインページの URL で代用しません。 |
| 400 | ft.SsoVerifyWellKnowURLInvalid | 検出リクエストの接続/JSON 解析などが失敗 | アイデンティティプロバイダー URL(wellKnowURL)の検証に失敗しました, err:{} | アドレス、ネットワーク、JSON レスポンスを確認し、traceId を保持します。同じ誤った設定を繰り返し送信しないでください。 |
| 400 | ft.SsoAuthSetInvalid | 明示的な authSet.url が有効な HTTP(S) アドレスではない | {} パラメータが無効です | 正式な authorization_endpoint を使用します。 |
| 400 | ft.SsoTokenEndPointInvalid | 明示的な getTokenSet.url が無効 | {} パラメータが無効です | 正式な token_endpoint を使用します。 |
| 400 | ft.SsoVerifyTokenSetInvalid | 明示的な verifyTokenSet.url が無効 | {} パラメータが無効です | 正式な JWKS アドレスを使用します。 |
| 400 | ft.SsoUserInfoEndPointInvalid | 明示的な getUserInfoSet.url が無効 | {} パラメータが無効です | 正式な userinfo_endpoint を使用します。 |
| 400 | ft.SsoOIDCUrlsInvalid | wellKnowURL がなく、auth/token/userinfo の 3 エンドポイントが揃っていない | url パラメータが無効です | 3 つの正式なアドレスを補完します。保存できてもプロトコル全体が検収済みとは限りません。 |
| 400 | ft.SsoGrantTypeInvalid | grantType が authorization_code/code ではない | grantType が無効です。現在は code、authorization_code のみをサポートします | サポートされる認可方式に変更します。 |
| 400 | ft.SSOEsistsSameSupplier | 同一ワークスペース内で削除されていないプロバイダー名が重複している(変更時は自身を除外) | 同名のプロバイダーが既に存在します | 既存の UUID で変更するか、一意の名前を選択します。 |
| 400 | ft.SSOEsistsSameIdp | 同一ワークスペース内で削除されていない設定が同じ IdP 識別情報ダイジェストを持つ(変更時は自身を除外) | 同じメタファイルの設定が既に存在します | 既存のプロバイダーを確認し、表示名を変えて同じ識別情報を重複作成しません。 |
| 500 | ft.InternalServerError | 動的 config/メール要素の形状、保存または復号/暗号化、メンバー関連付けのクリーンアップ、またはコミット後のキャッシュタスクで未捕捉例外が発生 | 内部エラー | まず get/list で設定/ホワイトリスト/メンバー関係を確認します。既にコミットされている可能性があります。traceId を保持し、失敗段階に応じて処理し、盲目的に再作成しません。 |
| 400 | ft.SSOCfgExceedQuantityLimit | 追加後の該当プロトコル設定数がサイト上限を超えている(無効化済みでも未削除なら計上) | SSO 設定数が制限を超えています | SSO 一覧で数と削除可能な履歴設定を確認します。サイトのデフォルトは種類ごとに 10 で、実際は上限設定に従います。 |