SSO 設定を更新(旧互換 API)¶
POST /api/v1/sso/saml_modify/{sso_uuid}
概要¶
既存の SAML/OIDC アイデンティティプロバイダー設定とメールアドレス許可リストを更新します。
呼び出し前の準備と使用手順¶
これは旧アドレス互換 API であり、現在のソースコードでも実際に登録されています。過去の「2026-05-31 提供終了」というコメントは、現在リクエストが禁止されていることを示すものではありません。新規接続ではSSO 設定を更新を優先して使用してください。旧パスは同じコントローラー/リクエストフィールド/レスポンスを踏襲しており、saml プレフィックスのため OIDC を除外するものではありません。
まず GET で現在のプロバイダーと許可リストをバックアップし、元の type に従って必要なフィールドを一括更新します。type は切り替えできません。emailDomains/idpName/role は仕様上必須で、許可リストは全体置換、[] でクリアします。remark を省略するとクリアされ、2 つのセッション期間は省略時に維持されます。config を省略または {} の場合は旧値を維持し、非空なら全体置換します。OIDC では必要なフィールドを完全に再設定する必要があり、旧 secret を保持する場合は GET が返す Base64 のアスタリスク値を渡します。SAML で非空の config を更新する場合は、有効な idpData も同時に再設定する必要があります。XML のみ変更する場合は config を省略して既存のマッピングを維持できますが、{} は旧 config のクリアを意味しません。
作成/変更では完全な SSO ログイン受け入れ検証は実行されません。wellKnowURL を指定した場合は、実際に GET によるサービスディスカバリを同期的に実行します(保存時はデフォルトで TLS 検証)。このアドレスがない場合は、auth/token/userinfo の 3 エンドポイントを明示できます。その他の認証、code から token への交換、JWT/UserInfo プロトコルの詳細はログイン時にのみ使用されます。現在、userinfo が get 以外でも GET + Body を送信するため、POST エンドポイントが利用できることは保証されません。OIDC のデフォルト scope は openid のみで、ユーザーソースは origin です。email/profile が必要な場合は、IdP の権限に従って明示的に指定し、実際にテストしてください。宣言されたフィールド型以外に、多くの動的フィールドは保存時に厳密に検証されないため、HTTP 200 だけでフロー全体がログイン可能と判断できません。
IdP のアイデンティティ(SAML entityID/ログインサービス URL、OIDC 認可 URL/clientId など)を変更すると、アカウントの名前空間が変わり、メンバーのワークスペース関連付けのクリーンアップがトリガーされる可能性があります。現在のクリーンアップは新しいアイデンティティダイジェストに基づいて実行され、「旧プロバイダーのユーザーのみをアンバインドする」ことは保証されません。共有メンバーの削除は、ロール/個人 Key/サブスクリプションなどの既存のクリーンアップルールにも関係するため、先に関連メンバーと代替管理者のエントリーポイントを確認してください。証明書/secret や携帯電話番号マッピングのみを更新しても、そのアイデンティティダイジェストが必ず変わるわけではありません。
データベースコミット後にワークスペース/メンバーキャッシュの更新が配信され、既存の SSO アクセスが再認証される可能性があります。設定レスポンスはキャッシュがすべて更新されたことを意味しません。needNotify はデフォルト true で、ワークスペースの Owner/管理者に設定リマインダーを送信します。false はメールのみを抑制し、監査/キャッシュは引き続き実行されます。メール送信に失敗した場合は記録されますが、設定はロールバックされません。変更レスポンスに emails が必ず含まれるわけではないため、再度 GET して許可リストを確認してください。書き込みレスポンスの secret は保存時の暗号文であり、詳細 GET でのみ保持に使用できるアスタリスクマスクが返されます。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sso_uuid | string | Y | 元のプロトコルのプロバイダーを変更するための識別子で、IdP clientId やマッピング fdmp_ は使用しません。 例: sso_example取得または入力方法: 本ワークスペースの SSO 一覧/get から対象の sso_ 設定 UUID を取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 設定が実行可能であると自動検証するものではありません。 例: 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 では非空の config のみを送信して idpData を省略することはできません。内部フィールド型はすべてが厳密検証されるわけではなく、保存成功はコールバックが利用可能であることを証明しません。 null を許可: False 例: {}取得または入力方法: OIDC はプロバイダーの client/ディスカバリドキュメントとプロトコルパラメータから構築します。SAML は任意の claimMapping にのみ使用します。 |
|
| emailDomains | array | Y | 必須の配列で、[] も可能です。サーバー側で set により重複排除されます。URL、正規表現、@ 付きのワイルドカードではありません。初回エントリのディスカバリでは完全なメールアドレスまたはドメインの等値一致を使用し、既存の SSO アイデンティティには別途名前空間/ワークスペース関係のルールがあるため、汎用的なアクセス制御の代替にはできません。変更時は許可リストを全体置換し、[] でクリアします。 例: ["example.com"]取得または入力方法: このプロバイダーのディスカバリを許可する完全なメールアドレスまたはメールドメイン(例: user@guance.com または example.com)を取得します。 |
| idpData | string | SAML の作成では業務上必須で、entityID、SSO サービス URL、鍵の説明を含む必要があります。変更時に省略/空文字列の場合は旧 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取得または入力方法: 組織のログインセッション最大寿命に応じて秒数を選択します。 |
パラメータ補足説明¶
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_modify/sso_example' \
-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":"KioqKioqKioq","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}'
レスポンス¶
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 です。このフィールドは主に編集モードを保持するもので、任意の expert 設定が実行可能であると自動検証するものではありません。 |
| 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.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,
"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": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
SAML リクエスト例:まず <IdP_METADATA_XML> を管理者が提供する完全で有効な XML に置き換えます(このプレースホルダーテキストのまま保存することはできません)。変更対象は元々 SAML である必要があります。
curl --request POST '<Endpoint>/api/v1/sso/saml_modify/sso_example' \
-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}'
OIDC 設定成功レスポンス例(secret は保存暗号文のプレースホルダーで、再設定には使用できません):
{
"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,
"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": {}
},
"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.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 を保持し、失敗段階に応じて対処し、無闇に再作成しないでください。 |
| 406 | ft.NotFoundSAML | UUID が現在のワークスペースの未削除 SSO 設定に属していない | sso 設定が見つかりません | SSO 一覧から sso_ UUID を再取得し、fdmp_ マッピングや idpMd5 は使用しません。 |
| 400 | ft.InvalidActionForbiddenRemovalOwner | アイデンティティ変更でトリガーされたメンバークリーンアップ対象に本ワークスペースの Owner が含まれる | 無効な操作です。所有者を削除できません | 先に関連アカウントと予備管理者のエントリーポイントを確認し、失敗を設定/メンバーがともに変更されていないとみなさないでください。 |
| 400 | ft.AgentMemberCanNotDelete | アイデンティティ変更で共有メンバーのクリーンアップがトリガーされ、削除不可のエージェントメンバーに該当 | agent 由来のメンバーは削除できません | 名前空間の対象を確認し、管理者に連絡して履歴関連付けを処理します。クリーンアップを無闇に再試行しないでください。 |