GET/orgunits/{orgUnitId}/members

組織のメンバーリストを取得する。

Authorization

oauth2

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

Scope

directory
directory.read
orgunit
orgunit.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/orgunits/{orgUnitId}/members

Path Parameters

ParameterTypeDescription
orgUnitId string 

組織を特定する ID (URL エンコードする)

  • 組織 ID (orgUnitId)
  • 組織の ExternalKey (externalKey:{orgUnitExternalKey})

required
example : orgunitf-f27f-4af8-27e1-03817a911417 

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 (OrgUnitMember) 

組織メンバーリスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

OrgUnitMember

PropertyTypeDescription
userId string 

ユーザーID (userId)


readOnly : true 
userExternalKey string 

ユーザーの ExternalKey


maxLength : 100
readOnly : true
nullable : true 
isManager boolean 

組織長フラグ


readOnly : true 
visible boolean 

ユーザー公開フラグ
組織図から組織のユーザーとして表示するかどうか。


readOnly : true 
useTeamFeature boolean 

組織のトークルーム機能の利用フラグ 組織に所属しているがトークルームでのメッセージ受信やファイル共有、組織メール受信などの、組織のトークルーム機能を制限したい場合にこのパラメータを利用する。
この値が true の場合、以下の機能を利用可能。

  • 組織トークルームのメンバーとして参加 (トーク、ノート、カレンダー、フォルダの閲覧)
  • 組織宛メールの受信
  • 組織カレンダーの参照、および宛の予定招待の受信
  • 組織宛に共有された掲示板、Drive、アンケート回答
  • 組織をグループのユーザーとして設定した場合、グループのユーザーに含まれる この値が false の場合、組織に提供される上記のすべての機能は利用できない。

readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "members": [3    {4      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",5      "userExternalKey": "USER_EXT_01",6      "isManager": true,7      "visible": true,8      "useTeamFeature": true9    }10  ],11  "responseMetaData": {12    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="13  }14}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found