コンテンツにスキップ

現在のテナント情報を取得



GET /api/v1/tenant/resolve

概要

現在の API Key が属するテナントと、紐付けられたユーザー識別子を解決します。

呼び出し前と使用手順

このエントリポイントはテナント解決が必要な連携で使用します。エントリポイントで許可された権限を持つ現在のワークスペースの API Key を使用してください。Query や Body は受け取りません。tenantId は現在のワークスペースの UUID、userId はその Key の accountUUID です。手動で作成したワークスペースの Key では通常、空文字列になります。token と expiresAt は現在常に空文字列であり、ログイン Token や有効期限付き資格情報は発行されません。

現在の Key リソースの UUID 単位で 1800 秒間キャッシュされ、キャッシュが先に返される場合があります。本 API をリアルタイムの権限確認、削除確認、有効期限確認に使用しないでください。成功時は生の JSON オブジェクトを返し、code/content/success/declaration は含まれません。エラー時は共通エラーシェルを使用します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/tenant/resolve' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

HTTP200、application/json の生オブジェクト。統一成功シェルや declaration はありません。エラーは共通エラー構造を使用します。

フィールド 型 説明
tenantId string 現在の Key が属するワークスペース UUID。テナント識別子として使用します。
userId string Key に紐付くアカウント UUID。手動 Key が未紐付けの場合は ""。
token string 現在は固定で空文字列。使用可能な認証資格情報ではありません。
expiresAt string 現在は固定で空文字列。Unix 時間や無期限を保証するものではありません。
{
  "tenantId": "wksp_example",
  "userId": "",
  "token": "",
  "expiresAt": ""
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたは応答説明 対処方法
401 ft.InvalidAPIKey キャッシュミスかつ現在のワークスペース内で現在の Key の有効なレコードが見つからない 無効な API Key Key が削除/無効化されていないこと、および現在のワークスペースに属していることを確認してください。wsak_ リソース UUID をリクエストヘッダーの Key として使用しないでください。
406 ft.NotFoundWorkspace Key に対応するワークスペースが存在しない/非アクティブ 指定されたワークスペースが見つかりません ワークスペースの状態と Key の関連付けを確認してください。
500 ft.InternalServerError ワークスペース/サイト/認可設定、データベースまたはキャッシュの読み取り、および応答フォーマットに失敗 内部エラー traceId とクエリ条件を保持し、再試行しても失敗が続く場合は管理者に設定の確認を依頼してください。空の結果からサイトにデータがないと判断しないでください。

フィードバック

このページは役に立ちましたか?