クロスサイト認可 meta のインポート¶
POST /api/v1/workspace_data/cross_site_grant/meta/import
概要¶
被認可側で完全な署名パッケージをインポートし、ソース側の認証を完了してローカルの active ミラーを確立します。
呼び出し前の準備と使用手順¶
dataRightsManage.workspaceConfigManage 権限を持つ API Key を使用します。ワークスペースは Key によって決まります。認可側はデータを提供するワークスペース、被認可側はデータを照会するターゲットワークスペースであり、両者は異なるワークスペースである必要があります。デプロイメントプランでは、まずデプロイメントプランのクロスサイト認可使用説明に従って、バージョン、自サイトの識別情報、証明書、および許可されたクロスサイト関係の設定を完了してください。秘密鍵は管理者がサーバー側に保管し、リクエスト/認可パッケージには含めません。
被認可側のサイトで、ターゲットワークスペースの Key を使用して {meta:完全な認可パッケージ} を送信します。まずパッケージの出所、targetWorkspaceUUID、有効期限、認可範囲を確認します。現在の公開 Body は meta のみを受け付け、controller 内部の authResult や、meta の各フィールドをリクエストのトップレベルに直接展開する方法はサポートしません。meta の生成が返す content.meta を読み取り、ファイルとして完全に受け渡します。本ページの例示用公開鍵/JWS を送信したり、秘密鍵を追加したりしないでください。
ターゲットサーバーはパッケージを検証した後、能動的に認可側へ認証を開始します(デフォルトのリクエストタイムアウトは 10 秒、サイトごとに設定可能)。認可側からターゲットへ能動的に接続することはありません。パッケージ内の認可側アドレスには、呼び出し元の PC だけでなく、ターゲットサーバーからアクセスできる必要があります。両側の対応するクロスサイト関係を有効にする必要があり、同一組織のターゲットには有効な公式サイト情報も必要です。同一サイト内のワークスペース認可には、サイト内認可を使用してください。
ローカルで active ミラーが正常に確立されて初めて、認可の選択とクエリのフローに進むことができます。認証交換とローカル保存は両端で別々に送信されるため、失敗してもソース側がすでにアクティブ化され、一時コードが消費されている可能性があります。元のパッケージが無制限に再生可能であると想定しないでください。同一の有効なミラーは通常、リモート交換の前に重複エラーを返します。duplicated=true は特定の既存レコードを再利用する分岐に限られ、冪等なリトライを保証するものではありません。失敗した場合は、まず両端の認可レコード一覧をそれぞれ確認してから、復旧/取消/再作成を判断してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: ターゲットワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| meta.version | string | 生成されたプロトコルバージョン。現在は 2026-05-27 で、元の値を保持します。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの version からそのまま取得し、独自に構築しないでください。 |
|
| meta.metaUUID | string | 今回の認可パッケージの識別子。以降の交換で使用します。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの metaUUID からそのまま取得し、独自に構築しないでください。 |
|
| meta.createdAt | integer | 生成日時(Unix 秒)。 例: 1785427200取得または入力方法: 実際の認可パッケージの createdAt からそのまま取得し、独自に構築しないでください。 |
|
| meta.expireAt | integer | 認可パッケージの有効期限(Unix 秒)。これより前にインポートする必要があります。 例: 1785427200取得または入力方法: 実際の認可パッケージの expireAt からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceWorkspace | object | データ認可側のワークスペース情報。 例: {}取得または入力方法: 実際の認可パッケージの sourceWorkspace からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceWorkspace.workspaceUUID | string | 認可側ワークスペースの UUID。ソース API Key によって決まります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceWorkspace.workspaceUUID からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceWorkspace.workspaceName | string | ソースワークスペース名のスナップショット。空の場合があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceWorkspace.workspaceName からそのまま取得し、独自に構築しないでください。 |
|
| meta.targetWorkspaceUUID | string | 被認可側ワークスペースの UUID。インポートに使用する Key のワークスペースと一致する必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの targetWorkspaceUUID からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite | object | 認可側サイトの識別情報とアクセスアドレス。サーバー側から提供され、ブランド/ドメインを独自に記入・置換しないでください。 例: {}取得または入力方法: 実際の認可パッケージの sourceSite からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.siteCode | string | 認可側サイトのコード。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.siteCode からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.regionCode | string | 認可側のリージョンコード。パッケージの元の値のまま送信します。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.regionCode からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.name | string | サイトの表示名。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.name からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.issuer | string | 認可側の署名識別子。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.issuer からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.baseUrl | string | インポート側サーバーが能動的にリクエストする認可側 API のベース URL。認可側から信頼できる形で提供され、疎通可能である必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.baseUrl からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.jwksUri | string | 認可側の公開鍵情報のアドレス。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.jwksUri からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.kid | string | 現在アクティブな署名 Key の識別子。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.kid からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.publicKeys | array<object> | サーバー側で絞り込まれた公開鍵の集合。秘密鍵は含みません。 例: []取得または入力方法: 実際の認可パッケージの sourceSite.publicKeys からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.publicKeys[*] | object | 1 件の公開鍵情報。 例: {}取得または入力方法: 実際の認可パッケージの sourceSite.publicKeys[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.publicKeys[*].kid | string | 対応する公開鍵の識別子。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.publicKeys[*].kid からそのまま取得し、独自に構築しないでください。 |
|
| meta.sourceSite.publicKeys[*].publicKey | string | PEM 公開鍵の本体。秘密鍵や API Key ではありません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの sourceSite.publicKeys[*].publicKey からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope | object | 正規化済みの認可範囲。 例: {}取得または入力方法: 実際の認可パッケージの grantScope からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.type | array<string> | データカテゴリの配列。 例: []取得または入力方法: 実際の認可パッケージの grantScope.type からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.type[*] | string | 1 つのカテゴリまたは*。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.type[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.indexes | array<string> | ログインデックス名の配列。ログ以外の認可では [] にできます。 例: []取得または入力方法: 実際の認可パッケージの grantScope.indexes からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.indexes[*] | string | インデックス名または*。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.indexes[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions | object | 4 種類のフィルター条件。構造は生成リクエストの conditions と同一で、完全に保持する必要があります。 例: {}取得または入力方法: 実際の認可パッケージの grantScope.conditions からそのまま取得し、独自に構築しないでください。 |
|
| meta.auth | object | 今回の一時認証情報。被認可側へ安全に受け渡す必要があります。 例: {}取得または入力方法: 実際の認可パッケージの auth からそのまま取得し、独自に構築しないでください。 |
|
| meta.auth.tempAuthCode | string | 1 回の交換で使用する 32 桁の小文字 16 進数の一時コード。生成後は完全に受け渡し、長期的な API Key ではありません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの auth.tempAuthCode からそのまま取得し、独自に構築しないでください。 |
|
| meta.auth.tempAuthCodeExpireAt | integer | 一時コードの有効期限(Unix 秒)。パッケージの有効期限とともに満たす必要があります。 例: 1785427200取得または入力方法: 実際の認可パッケージの auth.tempAuthCodeExpireAt からそのまま取得し、独自に構築しないでください。 |
|
| meta.security | object | 署名アルゴリズムと Key 情報。 例: {}取得または入力方法: 実際の認可パッケージの security からそのまま取得し、独自に構築しないでください。 |
|
| meta.security.signAlg | string | 現在は RS256。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの security.signAlg からそのまま取得し、独自に構築しないでください。 |
|
| meta.security.kid | string | 署名を生成した Key の識別子。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの security.kid からそのまま取得し、独自に構築しないでください。 |
|
| meta.signature | string | 完全な JWS 署名。例のプレースホルダー値ではインポートできません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの signature からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric | array | 任意の条件配列。未指定または [] は、このカテゴリに条件を追加しないことを意味し、そのカテゴリを禁止することを意味しません。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric[*] | object | 各項目はオブジェクトである必要があります。文字列や null で代用しないでください。 例: {}取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric[*].name | string | 一致対象のフィールド名で、表示エイリアスではありません。現在の作成時の検証ではフィールドの存在を網羅的に確認しないため、管理されたデータで範囲を検証する必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric[*].name からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric[*].op | string | in(含む)と not in(除外)のみをサポートします。= などの記号はサポートしません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric[*].op からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric[*].logic | string | 同一カテゴリ内で混在させると 406 になります。未知のロジックは完全には拒否されないため、クライアントは and/or のみを指定し、寛容な分岐に依存しないでください。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric[*].logic からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric[*].value | array | 配列である必要があります。要素には実際のフィールドに一致する値を使用し、カンマ区切りの文字列で配列を代用しないでください。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric[*].value からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.metric[*].value[*] | 実際のフィールド値 | 一致対象の 1 つの値。型と大文字小文字はデータと一致させる必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.metric[*].value[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing | array | 任意の条件配列。未指定または [] は、このカテゴリに条件を追加しないことを意味し、そのカテゴリを禁止することを意味しません。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing[*] | object | 各項目はオブジェクトである必要があります。文字列や null で代用しないでください。 例: {}取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing[*].name | string | 一致対象のフィールド名で、表示エイリアスではありません。現在の作成時の検証ではフィールドの存在を網羅的に確認しないため、管理されたデータで範囲を検証する必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing[*].name からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing[*].op | string | in(含む)と not in(除外)のみをサポートします。= などの記号はサポートしません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing[*].op からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing[*].logic | string | 同一カテゴリ内で混在させると 406 になります。未知のロジックは完全には拒否されないため、クライアントは and/or のみを指定し、寛容な分岐に依存しないでください。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing[*].logic からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing[*].value | array | 配列である必要があります。要素には実際のフィールドに一致する値を使用し、カンマ区切りの文字列で配列を代用しないでください。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing[*].value からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.tracing[*].value[*] | 実際のフィールド値 | 一致対象の 1 つの値。型と大文字小文字はデータと一致させる必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.tracing[*].value[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum | array | 任意の条件配列。未指定または [] は、このカテゴリに条件を追加しないことを意味し、そのカテゴリを禁止することを意味しません。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum[*] | object | 各項目はオブジェクトである必要があります。文字列や null で代用しないでください。 例: {}取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum[*].name | string | 一致対象のフィールド名で、表示エイリアスではありません。現在の作成時の検証ではフィールドの存在を網羅的に確認しないため、管理されたデータで範囲を検証する必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum[*].name からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum[*].op | string | in(含む)と not in(除外)のみをサポートします。= などの記号はサポートしません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum[*].op からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum[*].logic | string | 同一カテゴリ内で混在させると 406 になります。未知のロジックは完全には拒否されないため、クライアントは and/or のみを指定し、寛容な分岐に依存しないでください。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum[*].logic からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum[*].value | array | 配列である必要があります。要素には実際のフィールドに一致する値を使用し、カンマ区切りの文字列で配列を代用しないでください。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum[*].value からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.rum[*].value[*] | 実際のフィールド値 | 一致対象の 1 つの値。型と大文字小文字はデータと一致させる必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.rum[*].value[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage | array | 任意の条件配列。未指定または [] は、このカテゴリに条件を追加しないことを意味し、そのカテゴリを禁止することを意味しません。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage[*] | object | 各項目はオブジェクトである必要があります。文字列や null で代用しないでください。 例: {}取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage[*].name | string | 一致対象のフィールド名で、表示エイリアスではありません。現在の作成時の検証ではフィールドの存在を網羅的に確認しないため、管理されたデータで範囲を検証する必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage[*].name からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage[*].op | string | in(含む)と not in(除外)のみをサポートします。= などの記号はサポートしません。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage[*].op からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage[*].logic | string | 同一カテゴリ内で混在させると 406 になります。未知のロジックは完全には拒否されないため、クライアントは and/or のみを指定し、寛容な分岐に依存しないでください。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage[*].logic からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage[*].value | array | 配列である必要があります。要素には実際のフィールドに一致する値を使用し、カンマ区切りの文字列で配列を代用しないでください。 例: []取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage[*].value からそのまま取得し、独自に構築しないでください。 |
|
| meta.grantScope.conditions.lineage[*].value[*] | 実際のフィールド値 | 一致対象の 1 つの値。型と大文字小文字はデータと一致させる必要があります。 例: < 認可側の元の値を保持 >取得または入力方法: 実際の認可パッケージの grantScope.conditions.lineage[*].value[*] からそのまま取得し、独自に構築しないでください。 |
|
| meta | json | 完全なパッケージをオブジェクトとして送信します。ファイル名/JSON 文字列/レスポンスの外殻ではありません。フィールドと値は変更しません。JSON の空白やキー順の変化は許容されます。 null を許可: False 例: {"version": "2026-05-27", "metaUUID": "meta_example", "createdAt": 1785427200, "expireAt": 1785429000, "sourceWorkspace": {"workspaceUUID": "wksp_source", "workspaceName": "認可側ワークスペース"}, "targetWorkspaceUUID": "wksp_target", "sourceSite": {"siteCode": "source-region", "regionCode": "source-region", "name": "Guance サンプルサイト", "issuer": "https://source-site.example", "baseUrl": "https://source-site.example", "jwksUri": "https://source-site.example/api/v1/workspace_data/.well-known/cross-site-jwks.json", "kid": "key-example", "publicKeys": [{"kid": "key-example", "publicKey": "<サーバー側で生成された PEM 公開鍵>"}]}, "grantScope": {"type": ["logging"], "indexes": ["default"], "conditions": {}}, "auth": {"tempAuthCode": "0123456789abcdef0123456789abcdef", "tempAuthCodeExpireAt": 1785429000}, "security": {"signAlg": "RS256", "kid": "key-example"}, "signature": "<実際の認可側レスポンスの JWS。例はインポート不可>"}取得または入力方法: 認可側が実際にmeta の生成で返したレスポンスの content.meta、またはそれが保存した完全なファイルを使用する必要があります。 |
パラメータの補足説明¶
被認可側が、認可側で生成されたクロスサイト認可 meta をインポートします。インポート後は被認可側が能動的に認可側サイトへアクセスして認証と同期を完了し、認可側から被認可側へ能動的にアクセスすることはありません。
詳細はデプロイメントプランのクロスサイト認可使用説明を参照してください。
- デプロイメントプランのサービスは、少なくとも 2026-06-03 のリリースバージョンにアップグレードして初めて、新しいバージョンのサイト間認可方式をサポートします。
- インポートに成功すると、ローカルに mirror 認可レコードが生成されます。このレコードは active になった後でなければ、ワークスペースセレクター、認可検証、DQL クエリで使用できません。
- 同一の有効な meta を重複してインポートすると、既存の認可または重複認可エラーが返されます。詳細は API のレスポンスに従ってください。
- 以降の業務上の変更と取消には、引き続き
/wksp_share/<uuid>/modifyと/wksp_share/deleteを使用します。
リクエスト例¶
# grant-meta.json は認可側の実際のレスポンスの content.meta で、成功およびターゲットワークスペースを確認済み
jq '{meta: .}' grant-meta.json > grant-import.json
curl --request POST 'https://openapi.guance.com/api/v1/workspace_data/cross_site_grant/meta/import' \
-H 'DF-API-KEY: <被認可側API-KEY>' \
-H 'Content-Type: application/json' \
--data-binary @guance.com
レスポンス¶
HTTP 200、application/json。以下の例は、そのまま読み取れる主要なフィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.grantUUID | string | ターゲットサイトのローカル mirror レコードの UUID。ソース側の grantUUID とは異なります。 |
| content.status | string | 成功時は active で、ローカルに使用可能なミラーが保存されたことを示しますが、実際のクエリ環境がすべて検証済みであることを保証するものではありません。 |
| content.recordRole | string | mirror。被認可側のローカルレコードのロールです。 |
| content.duplicated | boolean | false は新規作成。特定の既存レコードの再利用では true になる場合がありますが、通常の重複インポートは直接エラーになることもあり、冪等性は保証されません。 |
| content.sourceWorkspaceUUID | string | データ提供側のワークスペース。 |
| content.targetWorkspaceUUID | string | ターゲット Key の現在のワークスペース。 |
| content.sourceWorkspaceName | string | 認可側の名前のスナップショット。空の場合があります。 |
| content.targetWorkspaceName | string | ターゲットワークスペース名。空の場合があります。 |
| content.regionCode | string | 新規作成の分岐では正規化されたソース側リージョンコードを返します。再利用の分岐では省略される場合があります。 |
| content.toRegionCode | string | 新規作成の分岐ではターゲットのリージョンコードを返します。再利用の分岐では省略される場合があります。 |
| content.siteRelationType | string | same_org_cross_site または external_org_cross_site。新規作成時は返され、再利用時は省略される場合があります。 |
| content.declaration | object | ターゲットワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"grantUUID": "grant_mirror_example",
"status": "active",
"recordRole": "mirror",
"duplicated": false,
"sourceWorkspaceUUID": "wksp_source",
"targetWorkspaceUUID": "wksp_target",
"sourceWorkspaceName": "認可側ワークスペース",
"targetWorkspaceName": "ターゲットワークスペース",
"regionCode": "source-region",
"toRegionCode": "target-region",
"siteRelationType": "same_org_cross_site",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストのエラーについては共通エラー定義を参照してください。
例は正常な新規作成の分岐のみを示しています。controller 内部の authResult 再生パスは公開 Body に含まれません。秘密鍵フィールドは共通エントリで再帰的に削除されます。auth.tempAuthCode は依然として機密性の高い 1 回限りの交換データであり、正当なターゲットにのみ安全に受け渡してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | リクエスト JSON のトップレベルがオブジェクトでない | 一部の json ファイルの形式エラー | リクエスト例に従って JSON オブジェクトを送信してください。 |
| 406 | ft.CrossSiteGrantSiteIdentityMissing | 現在のサイト識別情報の設定が不完全 | クロスサイト認可の自サイト識別情報設定が不完全です。グローバルの frontApiServerUrlPrefixFormat、または CrossSiteGrantCfg のカスタム issuer/baseUrl/jwksUri および証明書 keyId の設定を確認してください | 管理者がデプロイガイドに従って自サイトの識別情報とアドレスを確認します。 |
| 406 | ft.CrossSiteGrantCertificateInvalid | 現在のサイトの有効な署名証明書が未初期化または不完全 | クロスサイト認可の証明書が未初期化または不完全です。先にクロスサイト認可証明書の初期化スクリプトを実行してください | 管理者がアクティブ証明書を初期化/修復します。本 API に秘密鍵をアップロードしないでください。 |
| 406 | ft.CrossSiteGrantTargetWorkspaceMismatch | パッケージのターゲット UUID が現在の Key のワークスペースでない | 認可パッケージのターゲットワークスペースが現在のワークスペースと一致しません。正しいワークスペースに切り替えてから再インポートしてください | 正しいターゲットサイト/ワークスペースの Key に切り替えてください。署名パッケージを改変して強制的に一致させないでください。 |
| 406 | ft.CrossSiteGrantPackageInvalid | パッケージのフィールド/署名が無効、メタデータが改変されている、または形式が不完全 | 認可パッケージが無効または改ざんされています。認可側で生成された認可パッケージを再インポートしてください | 認可側で生成された完全な meta を再取得してください。 |
| 406 | ft.CrossSiteGrantPackageExpired | パッケージまたは一時コードが期限切れ | 認可パッケージの有効期限が切れています。認可側に連絡して認可パッケージを再生成してください | 認可レコードに従って古い pending を処理してから再生成してください。パッケージの時間を手動で延長しないでください。 |
| 406 | ft.CrossSiteGrantRelationDisabled | 今回のアクセス関係、または両端の対応する機能が有効になっていない | クロスサイト認可が有効になっていません。設定項目を有効にしてください: {} | 管理者が実際の関係に応じて該当する設定を有効にします。リクエストによって関係を偽装することはできません。 |
| 406 | ft.CrossSiteGrantSameOrgSiteUnresolved | 同一組織のソースサイト情報が未初期化、公式集合に存在しない、またはアドレスが一致しない | 同一組織のクロスサイト認可サイトが未初期化、または AllSiteBaseUrls の公式サイト集合に存在しません: {} | 管理者がサイト情報を確認します。パッケージの URL を独自に変更しないでください。 |
| 406 | ft.CrossSiteGrantSameSiteNotAllowed | 同一サイト関係としてインポートした | 同一サイト内のクロスワークスペース認可にはサイト内認可 API を使用してください。クロスサイト認可プロトコルによる作成は許可されません | サイト内認可 API を使用してください。 |
| 406 | ft.WKSPRepeatAuthorization | 現在のターゲットに同一の有効なソースサイト/ソースワークスペースのミラーが既に存在する | ワークスペースは既に認可されています。重複して認可しないでください! | 既存の認可を再利用します。再作成が必要な場合は事前に確認し、手順に従って取消してください。 |
| 406 | ft.CrossSiteGrantAuthFailed | リモートのタイムアウト/非成功、一時コードの消費失敗、署名識別子または交換情報の不一致 | クロスサイト認可の認証に失敗しました。認可パッケージがまだ有効か確認してから再試行してください | 両端の認可状態と疎通性を確認し、traceId を保持してください。消費済みのパッケージをむやみに再生しないでください。 |
| 500 | ft.InternalServerError | 異常なパッケージのネスト、署名リクエストの構築、データベースへのコミット、またはレスポンス処理の失敗 | 内部エラー | パッケージの整合性と両端のレコードを確認し、traceId を頼りに調査してください。失敗してもソース側が未アクティブ化であることを証明するものではありません。 |