콘텐츠로 이동

생성



POST /api/v1/workspace/member_group/add

개요

워크스페이스 팀과 그 멤버, 역할 연결을 생성합니다.

호출 전 및 사용 단계

먼저 워크스페이스 멤버 목록을 통해 워크스페이스 멤버를 준비하고, 역할 목록을 통해 팀에 할당할 수 있는 역할을 선택합니다. 팀 역할은 멤버가 상속할 수 있으며, 변경 후에는 알림 캐시를 정리하고 권한을 비동기적으로 새로 고칩니다. 따라서 성공 응답을 모든 로그인 세션에 즉시 반영되었다는 의미로 해석해서는 안 됩니다. 생성 시 유효하지 않은 멤버나 임의의 사용자 정의 역할 UUID가 자동으로 필터링되지는 않으므로, 사전 목록에 있는 실제 값을 사용해야 합니다. 멤버 UUID는 중복 제거할 것을 권장합니다. 데이터베이스와 후속 캐시/작업 처리는 단계적으로 수행되므로, 타임아웃 또는 500 발생 후에는 먼저 목록 또는 상세 정보를 조회해 결과를 확인하고, 중복 생성이나 새 구성 덮어쓰기를 피해야 합니다.

요청 헤더

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

Body 요청 파라미터

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

파라미터 추가 설명

생성 응답은 uuid만 제공하고 팀의 전체 엔터티를 반환하지 않습니다. 수정 응답은 true입니다. 실제 멤버와 역할은 목록 또는 상세 정보를 통해 조회하십시오.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/workspace/member_group/add' \
  -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 object 생성 결과입니다.
content.uuid string 새로 생성된 팀 UUID입니다.
content.declaration object 또는 null 워크스페이스 공통 선언입니다.
{
  "code": 200,
  "content": {
    "uuid": "group_example",
    "declaration": {}
  },
  "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 포함 팀 역할은 관리자 또는 소유자일 수 없습니다 소유자/관리자 식별자를 제거하고 허용된 역할만 사용합니다. 이 인터페이스로 팀 권한 부여 제한을 우회할 수 없습니다.
406 ft.MissingParameters 팀 이름이 비어 있음 파라미터 누락 비어 있지 않은 name을 제공합니다.
500 ft.InternalServerError 데이터베이스, 알림 캐시 정리, 비동기 권한 새로 고침 제출 또는 감사 실패 내부 오류 먼저 팀 구성이 이미 적용되었는지 확인한 후 재시도 여부를 결정합니다. traceId를 기록합니다. modify의 accountUUIDs=null도 이 오류를 유발할 수 있으므로 명확한 배열을 사용해야 합니다.

문서 평가

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