GET/groups/external-keys

그룹 외부 키 목록을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/external-keys

Query Parameters

ParameterTypeDescription
domainId integer 

도메인 ID


example : 10000001
format : int32 
count integer 

조회 개수


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
hasExternalKey boolean 

externalKey 여부로 필터링

  • true : externalKey 값이 있는 리소스로 필터링
  • false : externalKey 값이 없는 리소스로 필터링
  • 지정하지 않은 경우에는 모든 리소스를 가져온다.

example : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
groups array (TenantUniqueExternalKeyResponse) 

그룹 정보

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

TenantUniqueExternalKeyResponse

PropertyTypeDescription
domainId integer 

도메인 ID


format : int32
readOnly : true 
name string 

이름


readOnly : true 
email string 

메일 주소


readOnly : true 
id string 

ID.

조회 시 리소스에 자동 부여된 ID가 반환된다.


readOnly : true 
externalKey string 

고객사에서 관리하는 외부 키.


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값

 

Response Example

example

1{2  "groups": [3    {4      "domainId": 10000001,5      "name": "name01",6      "email": "group01@example.com",7      "id": "group127-8545-4463-603b-04d550d23bf",8      "externalKey": "GROUP_EXT_01"9    },10    {11      "domainId": 10000001,12      "name": "name02",13      "email": "group02@example.com",14      "id": "groupa36-79c8-4858-6c23-041098774484",15      "externalKey": "GROUP_EXT_02"16    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}