GET/users/{userId}/groups

ユーザーが所属するグループのリストを取得する。

注意

  • 外部グループでは取得できません。

Authorization

oauth2

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

Scope

directory
directory.read
user
user.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/groups

Path Parameters

ParameterTypeDescription
userId string 

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

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

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
count integer 

取得数


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

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


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
membershipType string 

ALL (既定) : グループや組織を介して所属するグループも含む。 DIRECT: ユーザーが直接所属するグループのみを含む。


default : ALL
Allowed values : DIRECT, ALL 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
groups array (UserGroup) 

グループ情報リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

UserGroup

PropertyTypeDescription
groupId string 

グループ ID


readOnly : true 
domainId integer 

ドメイン ID


format : int32 
groupName string 

グループ名

 
isGroupAdministrator boolean 

グループマスターフラグ

 
isGroupMember boolean 

グループメンバーフラグ
membershipType=ALL を指定し、グループマスターだがメンバーでないグループで FALSE になる。

 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "groups": [3    {4      "groupId": "group127-8545-4463-603b-04d550d23bf",5      "domainId": 10000001,6      "groupName": "Group1",7      "isGroupAdministrator": false,8      "isGroupMember": true9    }10  ],11  "responseMetaData": {12    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="13  }14}

HTTP 403

Forbidden

HTTP 404

Not Found