SSO 設定を作成¶
POST /api/v1/sso/create
概要¶
ワークスペースの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取得または入力方法: 実際のメールアドレス/ドメイン識別子を1つ取得し、アイデンティティソースが返す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では空でない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取得または入力方法: ワークスペースの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/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/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で、実際は上限設定に従います。 |