マッピング設定の削除¶
POST /api/v1/login_mapping/field/{lgmp_uuid}/delete
概要¶
指定したシステムログインマッピングルールを論理削除します。
呼び出し前の確認と使用手順¶
まずシステムログインマッピング一覧で uuid、ソース属性、ターゲットワークスペースを確認してください。この API には Body がなく、アクティブなシステムルールを 1 件だけ削除します。重複削除や、ワークスペースカスタムルールの UUID を渡した場合は 404 を返します。設定の削除は、付与済みのユーザーロールや既存セッションを直ちに取り消すことではありません。以降の関連ログインで権限がどのように変わるかは現在のモードによって異なります。GlobalValid は未一致の直接関係をクリーンアップする場合があり、Append は通常、既存のシステム付与関係を保持します。ワークスペースカスタムマッピングが有効な場合は、その優先ルールにも従います。直ちに権限を剥奪する必要がある場合は、メンバー/ロールおよびセッション管理のフローで確認して処理してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| lgmp_uuid | string | Y | アクティブなシステムマッピングの UUID であり、ワークスペース UUID ではありません。 例: lgmp_example001取得または入力方法: システムログインマッピング一覧 の content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョンです。省略したまま本ページのアルゴリズムを継続使用することはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用しており、サンプルの署名アルゴリズムと組み合わせて使用します。 |
|
| X-Df-Access-Key | string | Y | 読み取り API では r または w の認証情報を使用でき、書き込み API では 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 設定の API ではありません。設定の保存によって既存のすべてのユーザー権限が直ちに一括再計算されるわけではなく、以降の関連ログイン時にモードに従って処理されます。
システムマッピングが有効で、ターゲットワークスペースのカスタムマッピングが無効な場合、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 = 'POST'
path = '/api/v1/login_mapping/field/lgmp_example001/delete'
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 | boolean | 設定の削除が完了した場合に true になります。影響を受けるユーザーの一覧は返さず、ユーザー権限が直ちに再計算されたことを意味するものでもありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
確認済みのルールおよびリクエストエラーを表に示します。通常のデータベース/キャッシュ/監査の異常は最終的に 500 ft.InternalServerError になります。設定がコミットされた後に後続のエラーが発生する可能性があるため、まず現在の状態を読み取ってから再試行してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 404 | ft.LoginMappingNoExists | UUID が存在しない、削除済み、アクティブな status=0 ではない、またはシステムマッピングではない | 指定された Login Mapping が見つかりません | 本モジュールのシステムマッピング一覧から有効な uuid を再選択し、ワークスペースカスタムルールの UUID は使用しないでください。 |
| 500 | ft.InternalServerError | データベース、サイト設定キャッシュ、監査、または未処理の履歴データの異常 | 内部エラー | traceId を保持し、まずルールまたはスイッチを読み取って現在の状態を確認してください。データベースとキャッシュ/監査は同一トランザクションではないため、エラーが完全に未保存であることを証明するものではありません。 |