SSO 設定を更新¶
POST /api/v1/sso/{sso_uuid}/modify
概要¶
既存の 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 の権限に応じて明示し、実際にテストしてください。宣言されたフィールド型以外にも、保存時に厳密に検証されない動的フィールドが多数あるため、200 が返っただけでフロー全体がログイン可能と判断できません。
IdP の識別情報(SAML の entityID/ログインサービス URL、OIDC の認可 URL/clientId など)を変更すると、アカウントの名前空間が変わり、メンバーのワークスペース関連付けのクリーンアップがトリガーされる可能性があります。現在のクリーンアップは新しい識別情報のダイジェストに基づいて実行され、「旧プロバイダーのユーザーのみをアンバインドする」ことは保証されません。共有メンバーの削除では、ロール/個人 Key/サブスクリプションなどの既存のクリーンアップルールも関与するため、関連メンバーと代替管理者の入口を事前に確認してください。証明書/secret や電話番号マッピングのみの更新では、その識別情報ダイジェストが必ずしも変わるわけではありません。
データベースのコミット後にワークスペース/メンバーのキャッシュ更新が配信されるため、既存の SSO アクセスが再認証される可能性があります。設定レスポンスはキャッシュがすべて更新済みであることを意味しません。needNotify は既定で true で、ワークスペースのオーナー/管理者に設定リマインダーを送信します。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取得または入力方法: 実際の単一メールアドレス/ドメイン識別子を指定し、IdP が返す 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 が必要です。 例: 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 サービスアドレス、鍵の説明を含める必要があります。変更時に省略/空文字列の場合は旧 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取得または入力方法: ワークスペースのオーナー/管理者に設定変更を通知するかどうか。一括リハーサルではフローに応じて明示的に 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/sso_example/modify' \
-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 | プロバイダー識別情報/アカウント名前空間のダイジェスト。クライアント secret や書き込み可能な 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 保存では値/ソースを検証しませんが、コールバックでは引き続き email が必要です。 |
| 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/sso_example/modify' \
-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 由来のメンバーは削除できません | 名前空間の対象を確認し、管理者に連絡して履歴の関連付けを処理します。クリーンアップを盲目的に再試行しないでください。 |