GET/groups/{groupId}/administrators

グループマスターのリストを取得する

Authorization

oauth2

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

Scope

directory
directory.read
group
group.read

HTTP Request

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

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
administrators array (GroupAdministrator) 

グループマスターリスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

GroupAdministrator

PropertyTypeDescription
userExternalKey string 

ユーザーの ExternalKey


readOnly : true 
userId string 

ユーザーを特定する ID (URL エンコードする)

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

required 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "administrators": [3    {4      "userExternalKey": "USER_EXT_01",5      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"6    }7  ],8  "responseMetaData": {9    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="10  }11}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found