그룹 관리 API 메서드 group-management-api-methods
Rest API 그룹 만들기, 업데이트, 나열, 삭제 등 그룹 관리 방법
그룹 만들기 create-group
A POST 메서드를 사용하여 새 사용자 그룹을 만들 수 있습니다.
요청
POST /api/v1/groups/
샘플 요청 본문
{
"name" : <string>,
"description" : <string_may_be_null>,
}
응답
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
그룹 업데이트 update-group
A PUT 메서드를 사용하여 사용자 그룹을 업데이트할 수 있습니다.
요청
PUT /api/v1/groups/<groupId>
샘플 요청 본문
{
"name" : <string>,
"description" : <string_may_be_null>,
}
응답
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}
목록 그룹 list-groups
A GET 사용자 그룹을 나열하는 메서드입니다.
요청
GET /api/v1/groups/
응답
[
{
"groupId" : <integer>,
"pid" : <integer>,
"name" : <string>,
"description" : <string_may_be_null>,
"membershipCount" : <integer>,
"wildcards" : <list of strings>,
"users" : <list of user IDs>
}, ...
]
그룹 삭제 delete-groups
A DELETE 메서드를 사용하여 사용자 그룹을 삭제하고 해당 그룹에서 모든 구성원을 제거합니다.
요청
DELETE /api/v1/groups/<groupId>
반환 204 No Content 성공하면 충돌 반환 시 409 Conflict.
일괄 그룹 삭제 delete-groups-bulk
A DELETE 여러 그룹을 일괄적으로 삭제하고 해당 그룹에서 모든 구성원을 제거하는 방법입니다.
요청
DELETE /api/v1/groups/bulk-delete
반환 204 No Content 성공하면 충돌 반환 시 409 Conflict.
그룹에 대한 모든 권한 나열 list-permissions-group
A GET 그룹의 권한 개체를 나열하는 메서드입니다.
요청
GET /api/v1/groups/{groupId}/permissions
응답
[{
"objectId" : 34,
"objectType": "SEGMENT",
"permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
},
{
"objectId" : "234",
"objectType": "TRAIT",
"permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
},
{
"objectId" : 277,
"objectType": "SEGMENT",
"permissions": ["READ", "WRITE", "MAP_TO_MODELS"]
}
]
반환 400 Bad Request 그룹에 액세스할 수 없는 경우.
그룹에 대한 권한 설정 set-permissions-group
A PUT 그룹 권한을 업데이트하는 방법입니다. 이 메서드는 이전 권한을 새 권한으로 덮어씁니다.
요청
PUT /api/v1/groups/{groupId}/permissions/
응답
[
{ "objectType" : "SEGMENT",
"objectId" : 563,
"permissions" : [ "READ", "WRITE"]
},
{ "objectType" : "SEGMENT",
"objectId" : 2363,
"permissions" : [ "CREATE", "WRITE"]
},
{ "objectType" : "TRAIT",
"objectId" : 83498,
"permissions" : [ "READ", "MAP_TO_SEGMENTS"]
},
{ "objectType" : "DESTINATION",
"objectId" : 304,
"permissions" : [ "READ", "WRITE", "CREATE"]
}
]
샘플 응답은 업데이트된 권한 개체 목록을 나타냅니다.
반환 200 OK 성공하면 반환 400 지정된 권한이 잘못된 경우. 반환 가능 403 로그인한 사용자가 오브젝트에 액세스할 수 없는 경우