콘텐츠로 이동

삭제



POST /api/v1/super-account/delete

개요

지정된 관리자 백엔드 계정을 소프트 삭제합니다.

호출 전 확인 및 사용 단계

먼저 관리자 백엔드 계정 목록에서 대상 및 초기 슈퍼 관리자 표시를 확인하여 로그인 가능한 관리 계정이 남아 있도록 보장합니다. accountUuids CSV에 따라 status=3으로 일괄 표시하고 deleteAt을 설정합니다. 일반 비즈니스 계정이나 워크스페이스는 삭제하지 않습니다. 현재 삭제 분기에는 비활성화 분기의 Token 정리가 없으며 관리 계정 프로필 캐시도 갱신되지 않으므로, 성공 응답만으로 모든 기존 세션이 즉시 무효화되었다고 판단할 수 없습니다. 조직 절차에 따라 세션 폐기를 처리하고 검증한 후 삭제해야 합니다. 이 SYS 진입점은 초기 슈퍼 관리자 보호를 수행하지 않으며, 알 수 없거나 이미 삭제된 UUID는 무시됩니다.

요청 헤더

파라미터명 타입 필수 설명
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 초 문자열을 생성합니다.

Body 요청 파라미터

파라미터명 타입 필수 설명
accountUuids commaArray Y 필수 CSV 문자열이며 JSON 배열이 아닙니다. 필드 이름은 정확히 accountUuids입니다. 서버에서 직접 split하며 앞뒤 공백을 제거하지 않으므로 여러 UUID 사이에 공백을 넣지 마십시오. 알 수 없거나 이미 삭제된 UUID는 무시되며, 빈 문자열은 어떤 정상 계정과도 일치하지 않습니다.
null 허용: False
예시: mact_example001
획득 또는 입력 방법: 관리자 백엔드 계정 목록의 content.data[].uuid에서 하나 이상의 관리 계정을 가져와 영문 쉼표로 연결합니다.

파라미터 추가 설명

인증은 External API 서명 인증을 참조하십시오. 이 모듈은 사이트 관리자 백엔드 계정을 관리하며, UUID는 일반적으로 mact_이며 워크스페이스 비즈니스 구성원 acnt_도 아니고 공간 Owner도 아닙니다. 목록/상세는 r 또는 w 권한을 사용할 수 있고, 나머지는 w 권한이 필요합니다. External은 sys 신원으로 실행되며 일반 백엔드 계정의 초기 슈퍼 관리자에 대한 작업 제한을 적용하지 않으므로, 작업 전에 대상 계정과 아직 로그인 가능한 관리 계정을 확인해야 합니다. 반환은 일치하는 사용자 이름 하나 또는 빈 객체일 뿐이며 계정별 삭제 증명이 아닙니다. 삭제 후 목록/상세를 통해 각 계정을 확인하십시오. 이 인터페이스는 복구 진입점을 제공하지 않습니다.

요청 예시

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/super-account/delete'
query = {}
data = {'accountUuids': 'mact_example001'}
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 object 반환 요약이며 계정별 결과가 아닙니다.
content.username string 선택 사항: 일치하는 임의 레코드의 로그인 이름이며 순서는 보장되지 않습니다. 요약 조회 시 이미 삭제된 계정이 일치할 수 있으므로 이를 근거로 실제 업데이트 수량을 판단할 수 없습니다.
{
  "code": 200,
  "content": {
    "username": "api-doc-admin"
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

일치하는 레코드가 없을 때의 응답 예시:

{
  "code": 200,
  "content": {},
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

이 표는 현재 External SYS 분기에서 도달 가능한 비즈니스 오류만 보장하며, 일반 백엔드 실제 계정의 자기 보호 오류를 그대로 적용하지 않습니다. 데이터베이스/캐시 등 일반 5xx는 전역적으로 ft.InternalServerError로 통일되며, 상태나 프로필이 저장된 후에 실패할 수 있습니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 파라미터 파싱 실패 파라미터 위치, 필드 이름, 타입 및 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문 무효 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
400 ft.JsonFormatError JSON 최상위가 객체가 아님 일부 json 파일 형식 오류 표에 따라 JSON 객체를 제출합니다.
500 ft.InternalServerError 데이터베이스, 캐시, 감사 또는 처리되지 않은 필드 예외 내부 오류 traceId를 보관하고 계정의 현재 프로필과 상태를 확인합니다. 수정/삭제는 저장된 후에 실패할 수 있습니다.

문서 평가

이 페이지가 도움이 되었나요?