콘텐츠로 이동

삭제



POST /api/v1/role/{role_uuid}/delete

개요

현재 워크스페이스의 사용자 정의 역할과 권한 관계를 삭제하고 관련 메뉴 참조를 정리합니다.

호출 전 준비 및 사용 단계

역할 목록에서 워크스페이스 사용자 정의 역할을 선택하고, 삭제 전에 해당 역할을 사용하는 멤버/API Key, SAML 또는 로그인 매핑 및 SSO 설정을 먼저 마이그레이션해야 합니다. 시스템 예약 역할 및 관리 콘솔 애플리케이션의 내장 역할은 이 API로 삭제할 수 없습니다. 요청 본문은 없습니다. 성공 시 content={}를 반환하며 true가 아닙니다. 워크스페이스 사용자 정의 역할을 찾지 못한 경우에도 동일한 빈 객체가 반환될 수 있으므로 목록을 다시 조회하여 확인해야 합니다. 역할 삭제는 계정을 삭제하지 않습니다. 위의 직접 멤버/API Key, SAML/로그인 매핑 및 SSO 참조가 감지되면 먼저 해제한 후 다시 시도해야 합니다. 관리 계정 그룹 등 상속된 역할 매핑은 별도로 확인해야 하며, 이 API는 모든 상속 관계를 검증하거나 자동으로 해제하는 것을 보장하지 않습니다.

경로 매개변수

매개변수 이름 유형 필수 설명
role_uuid string Y 워크스페이스 사용자 정의 역할 UUID입니다. 이름 또는 관리 콘솔 내장 역할 템플릿 UUID로 대체하지 마세요.
예: role_example
획득 또는 입력 방법: 역할 목록의 content.data[].uuid에서 대상 워크스페이스 사용자 정의 역할을 가져올 수 있으며, 역할 상세로 확인할 수 있습니다.

요청 헤더

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

매개변수 추가 설명

이 API의 삭제 결과는 처리 흐름 종료만 의미하며, 항목별 참조 목록을 제공하지 않고 다른 주체에 필요한 비즈니스 역할을 대체하지도 않습니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/role/role_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content object 삭제 처리 시 빈 객체 {}를 반환합니다. 이 결과는 삭제 가능한 역할을 찾지 못한 경우도 포함하며 declaration을 추가하지 않습니다.
{
  "code": 200,
  "content": {},
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
400 ft.InvalidAction 시스템 예약 역할 또는 관리 콘솔 애플리케이션의 내장 역할 삭제 잘못된 작업 보호된 역할은 유지하고, 대상 워크스페이스의 사용자 정의 역할만 작업하세요.
400 ft.InvalidActionRoleExistsRefAccount 역할이 아직 멤버 계정 또는 API Key에서 직접 참조됨 현재 역할과 멤버 계정/API KEY가 연결되어 있습니다. 비운 후 삭제하세요 먼저 해당 주체의 역할 바인딩을 마이그레이션한 후 삭제하세요.
400 ft.InvalidActionRoleExistsRefSAMLMapping 역할이 아직 SAML 또는 사용자 정의 로그인 매핑에서 참조됨 현재 역할과 SAML Mapping이 연결되어 있습니다. 비운 후 삭제하세요 먼저 해당 매핑 규칙을 조정하세요.
400 ft.InvalidActionRoleExistsRefSSOSetting 역할이 아직 SSO 설정에서 참조됨 현재 역할과 SSO 설정이 연결되어 있습니다. SSO 설정을 업데이트한 후 역할을 삭제하세요 먼저 SSO 설정의 기본 역할을 변경하세요.
500 ft.InternalServerError 삭제, 메뉴 참조 정리 또는 기타 내부 처리 실패 내부 오류 먼저 역할이 여전히 존재하는지 및 참조 상태를 확인한 후 재시도 여부를 결정하세요. 계속 실패하면 traceId를 제공하세요.
401 ft.WKSPNotExistOrReleased 메뉴 참조 정리 시 워크스페이스가 이미 삭제되었거나 해제되었음을 발견 워크스페이스가 존재하지 않거나 해제됨 API Key에 해당하는 워크스페이스가 여전히 유효한지 확인하고 사용 가능한 워크스페이스를 다시 선택하세요.

문서 평가

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