GET/groups/{groupId}/members

グループのメンバーリストを取得する

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory
directory.read
group
group.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/{groupId}/members

Path Parameters

ParameterTypeDescription
groupId string 

グループを特定する ID (URL エンコードする)

  • グループ ID (groupId)
  • グループの ExternalKey (externalKey:{groupExternalKey})

required 

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID (既定値: 認可ドメイン ID)


example : 10000001
format : int32 
count integer 

取得数


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

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Response

HTTP 200

OK

PropertyTypeDescription
members array (GroupMember) 

グループメンバーリスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

GroupMember

PropertyTypeDescription
externalKey string 

グループメンバーのユーザー/組織/グループの ExternalKey


readOnly : true 
id string 

グループメンバーのユーザー/組織/グループの ID (URL エンコードする)
ユーザー ID は以下を指定可能

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required 
type string 

グループメンバータイプ

  • USER : ユーザー
  • ORGUNIT : 組織
  • GROUP : グループ

required
Allowed values : USER, ORGUNIT, GROUP 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "members": [3    {4      "externalKey": "USER_EXT_01",5      "id": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "type": "USER"7    },8    {9      "externalKey": "ORGUNIT_EXT_01",10      "id": "orgunitf-f27f-4af8-27e1-03817a911417",11      "type": "ORGUNIT"12    },13    {14      "externalKey": "GROUP_EXT_01",15      "id": "group769-e656-477d-69c7-04e2f73a4a77",16      "type": "GROUP"17    }18  ],19  "responseMetaData": {20    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="21  }22}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found