콘텐츠로 이동

멤버 삭제



POST /api/v1/workspace/member/batch_delete

개요

현재 워크스페이스에서 멤버를 제거하고 직접 역할, 팀 및 관련 개인 액세스 권한을 취소합니다.

호출 전 및 사용 단계

워크스페이스 멤버 목록에서 제거할 멤버 UUID를 가져오고, 업무 인수인계를 확인한 후 제출합니다. 제거는 현재 워크스페이스의 멤버 관계에만 영향을 미치며, 사이트 계정 자체는 삭제하지 않습니다. 소유자, 현재 호출자 및 에이전트 멤버에는 별도 제한이 있습니다. 이 워크스페이스의 직접 역할 및 팀 관계를 취소하고, 현재 활성화된 사용자 개인 Key를 삭제하며, 멤버 캐시와 이 워크스페이스의 로그인 토큰을 정리하고, 채널 구독을 비동기적으로 제거합니다. 이미 비활성화된 개인 Key 기록은 이 삭제 경로의 범위에 포함되지 않습니다. 관리 콘솔 계정 그룹을 통해 상속된 워크스페이스 액세스는 관리 그룹 관계에서 별도로 확인해야 하며, 이 작업을 모든 상속 권한의 일괄 해제로 간주해서는 안 됩니다. content=null을 반환하며 true가 아닙니다. 존재하지 않는 멤버 관계는 실제 변경이 없을 수 있으며, 항목별 결과를 제공하지 않습니다. 멤버 관계, 역할, 토큰 및 캐시 등의 처리는 단계별로 저장될 수 있습니다. 예외 또는 타임아웃 발생 후에는 먼저 멤버 및 역할 상태를 조회한 다음 재시도를 결정합니다.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 타입 필수 설명
accountUUIDs[*] string 배열 내 단일 문자열 식별자입니다.
예시: acnt_example
획득 또는 입력 방법: 워크스페이스 멤버 목록의 content.data[].uuid에서 현재 워크스페이스 멤버 계정 UUID를 가져옵니다. API Key UUID 또는 이메일이 아닙니다.
accountUUIDs array Y 대상 계정 UUID 배열로, 동일 워크스페이스의 실제 멤버를 전달하며 비어 있지 않은 문자열을 사용합니다.
null 허용: False
예시: ["acnt_example"]
획득 또는 입력 방법: 워크스페이스 멤버 목록의 content.data[].uuid에서 현재 워크스페이스 멤버 계정 UUID를 가져옵니다. API Key UUID 또는 이메일이 아닙니다.

파라미터 추가 설명

멤버 삭제는 해당 멤버의 이 워크스페이스 액세스에 영향을 미칩니다. 성공 후에는 목록과 역할 소스를 다시 조회하여 직접 멤버 및 상속 관계의 최종 상태를 확인합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/workspace/member/batch_delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"accountUUIDs":["acnt_example"]}'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 타입 설명
content null 정상 흐름에서는 반환 값이 없고 JSON은 null입니다. 항목별 삭제 확인은 제공하지 않습니다.
{
  "code": 200,
  "content": null,
  "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 객체를 제출합니다.
400 ft.ForbiddenAdminRemoveSelf 대상 목록에 현재 호출자 ID가 포함됨 잘못된 작업, 관리자는 자신을 제거할 수 없습니다 멤버 관리 권한이 있는 다른 ID로 작업합니다.
400 ft.InvalidActionForbiddenRemovalOwner 대상 목록에 워크스페이스 소유자가 포함됨 잘못된 작업, 소유자를 제거할 수 없습니다 먼저 절차에 따라 소유자를 이전합니다.
400 ft.AgentMemberCanNotDelete 대상 계정에 에이전트 멤버가 포함됨 에이전트 소스 멤버는 삭제할 수 없습니다 에이전트 관리 절차를 통해 제거합니다.
500 ft.InternalServerError 데이터 저장, 연관 리소스 또는 캐시 처리 실패 내부 오류 먼저 멤버 및 권한의 현재 상태를 확인한 후 재시도를 결정합니다. 지속적으로 실패하면 traceId와 마스킹된 요청을 제공합니다.

문서 평가

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