API DocsUsersGroups

그룹

그룹 멤버십 및 권한 관리

개요

모든 그룹 엔드포인트는 /api/v1/groups 아래에 있습니다. 그룹은 사용자를 조직하고 대량 권한을 관리하는 데 사용됩니다. 생성, 업데이트, 삭제에는 관리자 역할이 필요합니다.

기본 URL:

목록 조회 및 생성

GET /groups/

관리자에게는 모든 그룹을 반환합니다. 일반 사용자에게는 자신이 속한 그룹만 반환합니다.

GETAuth required

그룹 목록을 조회합니다.

응답 200

json
[
{
  "id": "group-uuid",
  "name": "Engineering",
  "description": "Engineering team",
  "user_ids": ["user-uuid-1", "user-uuid-2"],
  "created_at": 1700000000
}
]

POST /groups/create

새 그룹을 생성합니다.

POSTAdmin only

새 그룹을 생성합니다.

요청 본문

json
{
"name": "Engineering",
"description": "Engineering team"
}

응답 200

json
{
"id": "group-uuid",
"name": "Engineering",
"description": "Engineering team",
"user_ids": [],
"created_at": 1700000000
}

GET /groups/id/{id}

ID로 단일 그룹을 가져옵니다.

GETAdmin only

ID로 그룹을 가져옵니다.

응답 200

그룹 객체.

오류

상태 코드설명
404그룹을 찾을 수 없음

그룹 작업

POST /groups/id/{id}/update

그룹의 이름, 설명 또는 멤버 목록을 업데이트합니다.

POSTAdmin only

그룹 상세 정보를 업데이트합니다.

요청 본문

json
{
"name": "Updated Name",
"description": "Updated description",
"user_ids": ["user-uuid-1", "user-uuid-2"]
}

POST /groups/id/{id}/users/add

기존 멤버를 교체하지 않고 그룹에 사용자를 추가합니다.

POSTAdmin only

그룹에 사용자를 추가합니다.

요청 본문

json
{ "user_ids": ["user-uuid-1", "user-uuid-2"] }

POST /groups/id/{id}/users/remove

그룹에서 사용자를 제거합니다.

POSTAdmin only

그룹에서 사용자를 제거합니다.

요청 본문

json
{ "user_ids": ["user-uuid-1"] }

DELETE /groups/id/{id}/delete

그룹을 영구적으로 삭제합니다.

DELETEAdmin only

그룹을 삭제합니다.

응답 200

json
true

오류

상태 코드설명
404그룹을 찾을 수 없음