콘텐츠로 이동

수정



POST /api/v1/workspace/member_group/{group_uuid}/modify

개요

워크스페이스 팀과 그 멤버 및 역할 연결을 완전히 교체합니다.

호출 전 준비 및 사용 단계

먼저 팀 상세에서 기존 팀 이름, 전체 멤버 및 역할을 저장한 다음 세 가지 전체 필드를 제출합니다. 이 작업은 부분 업데이트가 아닙니다. accountUUIDs=[]는 모든 멤버를 제거하고, roleUUIDs=[]는 모든 연결된 역할을 제거합니다. 빈 배열 대신 null을 전달할 수 없습니다. 먼저 워크스페이스 멤버 목록을 통해 워크스페이스 멤버를 준비하고, 역할 목록을 통해 팀에 할당 가능한 역할을 선택합니다. 팀 역할은 멤버가 상속할 수 있으며, 변경 후에는 알림 캐시를 정리하고 권한을 비동기로 새로 고칩니다. 성공 응답을 모든 로그인 세션의 권한이 즉시 새로 고쳐졌다는 의미로 해석해서는 안 됩니다. 데이터베이스와 후속 캐시/작업 처리는 단계적으로 실행되므로, 타임아웃 또는 500 발생 후에는 먼저 목록이나 상세를 조회하여 결과를 확인하고 중복 생성이나 새 구성 덮어쓰기를 피하십시오.

경로 파라미터

파라미터 이름 유형 필수 설명
group_uuid string Y 대상 팀 UUID이며 현재 워크스페이스에 속해야 합니다.
예시: group_example
가져오기 또는 입력 방법: 팀 목록의 content[].uuid에서 팀 UUID를 가져옵니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
accountUUIDs[*] string 단일 워크스페이스 멤버 계정 UUID 문자열입니다. 수정 시 현재 멤버 범위에 없는 UUID는 필터링됩니다. 생성 시 이 API로 멤버의 실제 존재 여부를 검증하지 않습니다.
예시: acnt_example
가져오기 또는 입력 방법: 워크스페이스 멤버 목록에서 반환된 멤버의 uuid에서 가져옵니다.
roleUUIDs[*] string 단일 역할 UUID 문자열입니다. 생성 시 임의의 사용자 지정 UUID의 유효성 검증을 보장하지 않으므로 목록의 실제 값을 사용해야 합니다.
예시: role_example
가져오기 또는 입력 방법: 역할 목록의 역할 uuid에서 복사하며 owner와 wsAdmin은 제외합니다.
accountUUIDs array Y 전체 멤버 UUID 배열입니다. 생성 시 생략하거나 null로 두면 멤버를 추가하지 않습니다. 수정 시 필수이며 전체를 교체합니다. []는 멤버를 비우고, null은 내부 오류를 발생시키므로 []를 대체할 수 없습니다.
null 허용: True
예시: ["acnt_example"]
가져오기 또는 입력 방법: 워크스페이스 멤버 목록에서 현재 워크스페이스의 실제 멤버 UUID를 가져옵니다. 상세의 membersNotInGroup에서도 후보를 제공할 수 있습니다.
name string Y 팀 이름이며 최대 48자입니다. 같은 워크스페이스의 활성 팀과 이름이 중복될 수 없습니다.
null 허용: False
최대 길이: 48
예시: 生产运维
가져오기 또는 입력 방법: 팀 목록에서 워크스페이스 내 기존 이름을 확인하고 비어 있지 않은 이름을 입력합니다.
roleUUIDs array Y 팀에 연결된 역할의 전체 배열입니다. 생성 시 생략하거나 null로 두면 역할을 추가하지 않습니다. 수정 시 필수이며 전체를 교체합니다. [] 또는 null은 역할을 비우므로 []를 명시적으로 사용하는 것이 좋습니다. 팀을 통해 소유자 또는 관리자 역할을 부여할 수 없습니다.
null 허용: True
예시: ["role_example"]
가져오기 또는 입력 방법: 역할 목록에서 할당 가능한 역할 UUID를 가져오며 owner 또는 wsAdmin은 사용할 수 없습니다.

파라미터 추가 설명

생성 응답은 uuid만 제공하며 팀의 전체 엔터티를 반환하지 않습니다. 수정 응답은 true입니다. 실제 멤버와 역할은 목록 또는 상세를 통해 읽어야 합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/workspace/member_group/group_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"生产运维","accountUUIDs":["acnt_example"],"roleUUIDs":["role_example"]}'

응답

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

필드 유형 설명
content boolean 구성 수정이 완료되면 true입니다.
{
  "code": 200,
  "content": true,
  "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.MemberGroupNameExists 현재 워크스페이스에 같은 이름의 활성 팀이 이미 있습니다. 같은 이름의 팀이 이미 존재합니다. 기존 이름을 조회하고 사용되지 않은 팀 이름을 선택하십시오.
400 ft.TeamRoleAddPermissionError roleUUIDs에 owner 또는 wsAdmin이 포함되어 있습니다. 팀 역할은 관리자 또는 소유자일 수 없습니다. 소유자/관리자 지정을 제거하고 허용된 역할만 사용하십시오. 이 API는 팀 권한 부여 제한을 우회할 수 없습니다.
404 ft.MemberGroupNoExists 대상 팀이 존재하지 않거나 삭제되었거나 현재 워크스페이스에 없습니다. 팀이 존재하지 않습니다. 팀 목록에서 활성 팀 UUID를 다시 복사하십시오.
500 ft.InternalServerError 데이터베이스, 알림 캐시 정리, 비동기 권한 새로 고침 제출 또는 감사 실패 내부 오류 먼저 팀 구성이 이미 적용되었는지 확인한 후 재시도 여부를 결정하십시오. traceId를 기록하십시오. modify의 accountUUIDs=null도 이 오류를 발생시킬 수 있으므로 명시적인 배열을 사용하십시오.

문서 평가

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