スイッチ状態情報を取得¶
GET /api/v1/login_mapping/switch/get
概要¶
サイトのシステムログインマッピングのスイッチと適用モードを照会します。
呼び出し前の準備と使用手順¶
r または w 権限の External 認証情報が必要です。リクエストボディや Query を渡さない場合、サイトレベルのシステムマッピング設定を読み取ります。設定がない場合のデフォルトは isDisable=true、type=GlobalValid です。ここでの GlobalValid はモードのデフォルト値であり、機能が有効であることを示すものではありません。返されるのは特定のワークスペースのカスタムマッピングスイッチではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョン。省略したうえで本ページのアルゴリズムを使い続けることはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用しており、サンプルの署名アルゴリズムと組み合わせて使用します。 |
|
| X-Df-Access-Key | string | Y | 読み取りインターフェースでは r または w の認証情報を使用でき、書き込みインターフェースでは w の認証情報が必要です。 例: <external-access-key>取得または入力方法: サイト管理者が External API AK を割り当てます。ワークスペースの OpenAPI Key は使用できません。 |
| X-Df-Nonce | string | Y | 一時的なシリアル番号。失敗して再送する場合も新しい値を生成し、署名を再計算します。 例: 97d275ee9f774315a7885ba7347acbd9取得または入力方法: リクエストごとに uuid.uuid4().hex を再生成します。 |
| X-Df-Signature | string | Y | 大文字のメソッド、nonce、元の完全なパス、timestamp、および元の UTF-8 リクエストボディをスペースで連結し、HMAC-SHA256 で hex ダイジェストを取得します。 例: <hmac-sha256-hex>取得または入力方法: External API 署名認証に従い、対応する SK で計算します。完全に実行可能なテンプレートは以下を参照してください。 |
| X-Df-Timestamp | string | Y | サイトで設定された署名の有効時間枠内である必要があり、サンプルの時刻を再利用することはできません。 例: 1785427200取得または入力方法: 送信時に str(int(time.time())) で現在の Unix 秒文字列を生成します。 |
パラメータの補足説明¶
認証方式はExternal API 署名認証を参照してください。本モジュールはサイトのシステムログインマッピング(isSystem=1)を管理し、OIDC/LDAP など共有ログインマッピング経路を使用するサードパーティログインで利用されます。ワークスペースのカスタムマッピングや独立した SAML 設定インターフェースではありません。設定を保存しても既存の全ユーザーの権限が直ちに一括再計算されることはなく、以降の関連ログイン時にモードに従って処理されます。
システムマッピングが有効で、対象ワークスペースがカスタムマッピングを無効にしている場合:ValidOnFirstLogin は、履歴上直接的なワークスペース関連付けがまったくないアカウントにのみシステムルールを適用します(履歴には削除済みの関連付けも含まれます)。これは今回アカウントが新規作成されたかどうかだけを判定するものではありません。GlobalValid は、関連するログインのたびにルールに従って直接ロールを置き換え、一致しない場合は直接メンバー/ロール関係を削除することがあります。Append は一致するシステムロールを追加するだけで、一致しない場合も元の直接関係をクリアしません。ワークスペースがカスタムマッピングを有効にしている場合、そのワークスペースはカスタムルールを優先して置き換えや不一致時のクリアを実行し、システムの Append や初回モードの保持セマンティクスを適用することはできません。システムスイッチをオフにしても、ワークスペースのカスタムルールが同時にオフになるわけではありません。既存の直接 Owner ロールは一致処理の中で保持され、本モジュールから新たに Owner を付与することはありません。
リクエスト例¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 対象サイトのアドレスと管理者が割り当てた External API AK/SK に置き換えます。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'GET'
path = '/api/v1/login_mapping/switch/get'
query = {}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
レスポンス¶
HTTP 200、application/json の統一エンベロープです。External は declaration を自動注入しません。リストのページネーションは content.pageInfo にあります。
| フィールド | 型 | 説明 |
|---|---|---|
| content.isDisable | boolean または integer | true/1 で無効、false/0 で有効。空の書き込みリクエストの履歴値が整数 0 で保存されることがあります。 |
| content.type | string | システムマッピングモード:ValidOnFirstLogin、GlobalValid、Append。省略時は GlobalValid を補完します。 |
{
"code": 200,
"content": {
"isDisable": true,
"type": "GlobalValid"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストのエラーは共通エラー定義を参照してください。
確認済みのルールおよびリクエストエラーは表に記載しています。通常のデータベース/キャッシュ/監査の例外は最終的に 500 ft.InternalServerError になります。設定がコミットされた後に後続のエラーが発生する可能性があるため、まず現在の状態を読み取ってから再試行してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | データベース、サイト設定キャッシュ、監査、または未処理の履歴データの異常 | 内部エラー | traceId を保持し、まずルールまたはスイッチを読み取って現在の状態を確認してください。データベースとキャッシュ/監査は同一トランザクションではないため、エラーが完全に未保存であることを証明するものではありません。 |