コンテンツにスキップ

有効化/無効化



POST /api/v1/account/set-disable

概要

指定したアカウントを一括で有効化または無効化します。

呼び出し前の準備と使用手順

External 認証情報の w 権限が必要です。isDisable=true で無効(status=2)、false で正常(status=0)に設定します。無効化時は、該当アカウントのログイン Token のクリアとプロファイルキャッシュのクリアを試行し、その後、関連ワークスペースのアラート設定を非同期で更新します。Token のクリアに失敗した場合はログが記録されますが、API は成功する可能性があります。そのため、強制ログアウトを確実に行う必要がある場合は管理者に確認してください。有効化しても元の Token は復元されず、メンバーは再ログインする必要があります。不明な UUID または削除済みの 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 秒文字列を生成します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
accountUUIDs[*] string 単一の対象アカウント UUID 文字列です。ワークスペース UUID ではありません。
例: acnt_example001
取得方法または入力方法: アカウント一覧 の content.data[].uuid から項目ごとに取得します。
accountUUIDs array Y 対象アカウント UUID の配列です。クライアントは事前に対象範囲を確認し、空でない文字列リストを送信してください。空の配列を送信してもすべてのアカウントが一括で影響を受けることはなく、不明な UUID または削除済みの UUID は無視されます。
null を許可: False
例: ["acnt_example001"]
取得方法または入力方法: アカウント一覧 の content.data[].uuid から項目ごとに取得します。wksp_ ワークスペース UUID は入力しないでください。
isDisable boolean Y 必須のブール値であり、文字列ではありません。無効化する前に、アカウントを引き続き保持する必要があるか確認してください。
null を許可: False
選択可能な値: [True, False]
例: true
取得方法または入力方法: 対象の状態に応じて true(無効化)または false(有効化)を選択します。

パラメータの補足説明

サイトレベルの External API 認証情報を使用します。認証方法はExternal API 署名認証を参照してください。以下の例では署名バージョン v20240417 を使用しています。署名対象のパス、Query エンコード、および元のリクエストボディは、実際に送信する内容と完全に一致している必要があります。返されるアカウント情報には password フィールドは含まれません。mfaSecret は固定のマスク値のみであり、ログインに使用できるキーではありません。この操作ではワークスペースのメンバーとロールの関係が保持されます。再度有効化した後も元の関連付けは残ります。成功は API 処理の完了のみを示します。status は一覧から確認してください。

リクエスト例

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/account/set-disable'
query = {}
data = {'accountUUIDs': ['acnt_example001'], 'isDisable': True}
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、Content-Type は application/json で、統一されたレスポンスエンベロープです。業務データは content にあります。External API は declaration を自動的に追加しません。リストのページネーションは content.pageInfo に保持されます。

フィールド 型 説明
content object 成功時は空のオブジェクト {} です。アカウントごとの結果ではなく、不明な UUID も個別にエラー報告されません。
{
  "code": 200,
  "content": {},
  "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 リクエストボディの JSON のトップレベルがオブジェクトではありません 一部の JSON ファイルの形式エラー JSON オブジェクトを使用し、配列、文字列、または null をトップレベルとして送信しないでください。
400 ft.AgentMemberCanNotDisable isDisable=true で無効化する場合に限り、バッチ内に source=agent かつ status が 0、1、2 のアカウントが存在します agent ソースのメンバーは無効化できません そのバッチから agent ソースのアカウントを除外し、対応する連携を通じてその状態を管理してください。
500 ft.InternalServerError データベース、キャッシュ、非同期タスクの投入、または明示的に処理されていないフィールドの異常 内部エラー traceId を保存して管理者に連絡してください。書き込みリクエストの場合は、まずアカウントの現在の状態を再照会し、確認したうえで再試行するかどうかを決定してください。500 を直ちに「未反映」とみなすことはできません。

フィードバック

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