GET/Groups

그룹 목록을 조회한다.

내부 그룹과 동적 그룹만 조회할 수 있고, 외부 그룹은 조회할 수 없다.
구성원, 그룹 유형의 그룹 구성원만 조회할 수 있다. 조직 유형의 그룹 구성원은 조회할 수 없다.

HTTP Request

GEThttps://www.worksapis.com/scim/v2/Groups

Query Parameters

ParameterTypeDescription
startIndex integer 

Offset


default : 1
minimum : 1 
count integer 

조회 개수


default : 100
minimum : 0
maximum : 100 
filter string 

필터
displayName 속성을 eq 비교만 가능
+는 %2B로 변환해야 한다.


example : displayName eq "group name" 
excludedAttributes string 

응답값에서 제외할 속성


Allowed values : members 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

SCIM 전용 Long-Lived Token 발급 문서를 참고한다.


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL

 
totalResults integer 

전체 개수

 
startIndex integer 

오프셋

 
itemsPerPage integer 

조회된 리소스 개수

 
resources array (ScimGroupResponse) 

그룹 정보

 

ScimGroupResponse

PropertyTypeDescription
schemas array (string) 

Schema URL

 
id string 

그룹 ID

 
externalId string 

SCIM 클라이언트 측에서 관리하는 ID

 
displayName string 

그룹명

 
members array (ScimGroupMember) 

그룹 구성원 목록

 
meta object (meta) 
 

ScimGroupMember

PropertyTypeDescription
value string 

그룹 구성원 ID(구성원 ID 또는 그룹 ID)


required 
type string 

그룹 구성원 유형


Allowed values : USER, GROUP
readOnly : true 
display string 

그룹 구성원 이름(구성원 이름 또는 그룹명)


readOnly : true 
$ref string 

참조 URL

그룹 구성원의 상세 정보를 조회한다.


readOnly : true 

meta

PropertyTypeDescription
resourceType string 

리소스 유형


Allowed values : USER, GROUP 
created string 

생성일

 
lastModified string 

최근 수정일

 
location string 

리소스 URI

 

HTTP 400

Bad Request