GET/groups

グループリストを取得する。

Authorization

oauth2

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

Scope

directory
directory.read
group
group.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups

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 

Response

HTTP 200

OK

PropertyTypeDescription
groups array (Group) 

グループリスト

 
responseMetaData object (responseMetaData) 

応答メタデータ

 

Group

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
groupId string 

グループ ID

  • グループのリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
groupName string 

グループ名
ドメイン内で一意。


required
maxLength : 100 
description string 

グループ説明


maxLength : 300
nullable : true 
visible boolean 

グループ公開フラグ 管理者/グループメンバー以外のメンバーによる検索の結果に表示するか否か


default : true 
useServiceNotification boolean 

サービス通知送信フラグ


default : false 
serviceManageable boolean 

グループマスターによる利用機能の変更可否フラグ


default : true 
groupExternalKey string 

グループの ExternalKey

  • テナント内で一意になること
  • 許容しない特殊文字: /%#?\

maxLength : 100
nullable : true 
administrators array (GroupAdministrator) 

グループマスターリスト


required
minItems : 1 
members array (GroupMember) 

グループメンバーリスト


required 
useMessage boolean 

トークの利用フラグ

  • false に変更すると、30 日後にすべてのメンバーの会話記録およびトークルーム機能 (ノート、カレンダー、フォルダ) のデータが削除される。
  • 30 日以内に再び true に設定すると、以前のデータを再度確認することができる。データがすべて削除された後は、以前のデータを確認することができず、true に設定すると新しいトークルームが生成される。

default : false 
useNote boolean 

ノートの利用フラグ

  • トーク利用時のみ利用できる
  • false に設定すると、ノート機能が利用できなくなる。true に設定することで以前のデータを確認できる。

default : false 
useCalendar boolean 

予定の利用フラグ

  • トーク利用時のみ利用できる
  • false に設定すると、予定機能が利用できなくなる。true に設定することで以前のデータを確認できる。

default : false 
useTask boolean 

タスクの利用フラグ

  • トーク利用時のみ利用できる
  • false に設定すると、タスク機能が利用できなくなる。true に設定することで以前のデータを確認できる。

default : false 
useFolder boolean 

フォルダの利用フラグ

  • トーク利用時のみ利用できる
  • false に設定すると、ノート機能が利用できなくなる。true に設定することで以前のデータを確認できる。

default : false 
useMail boolean 

メーリングリストの利用フラグ

  • アドバンストプランのみ利用できる
  • この値が true の場合、groupEmail は必須

default : false 
groupEmail string 

グループメールアドレス (メーリングリスト利用時)
localpart@domain の場合の localpart の制限

  • 2～64 字の英小文字、数字、ドット(".")、ハイフン("-")、アンダーバー("_")、エクスクラメーションマーク("!")、ハッシュマーク ("#") のみ使用できる
  • 最初の文字は英小文字、数字、エクスクラメーションマーク ("!")、ハッシュマーク ("#") のみ使用できる
  • ドット (".") は最初と最後、および連続("..") では使用できない

minItems : 0
maxLength : 90 
aliasEmails array (string) 

グループのサブメールアドレスリスト (メーリングリスト利用時)
localpart@domain の場合の localpart の制限

  • 2～64 字の英小文字、数字、ドット(".")、ハイフン("-")、アンダーバー("_")、エクスクラメーションマーク("!")、ハッシュマーク ("#") のみ使用できる
  • 最初の文字は英小文字、数字、エクスクラメーションマーク ("!")、ハッシュマーク ("#") のみ使用できる
  • ドット (".") は最初と最後、および連続("..") では使用できない

minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

外部メールの受信可否フラグ(メーリングリスト利用時)


default : false 
toExternalEmails array (string) 

メーリングリストに含む外部メールアドレスのリスト
社内メールのドメインは使用できない


minItems : 0
maxItems : 500 
membersAllowedToUseGroupEmailAsRecipient array (GroupAllowedMember) 

メーリングリスト宛てにメールを送信できるメンバーのリスト (メーリングリスト利用時)


minItems : 0 
membersAllowedToUseGroupEmailAsSender array (GroupAllowedMember) 

メーリングリストを送信メールアドレスとして使用できるメンバーのリスト (メーリングリスト利用時)
グループマスターやメンバーのみ指定できる


minItems : 0 

GroupAdministrator

PropertyTypeDescription
userExternalKey string 

ユーザーの ExternalKey


readOnly : true 
userId string 

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

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

required 

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 

GroupAllowedMember

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  "groups": [3    {4      "domainId": 10000001,5      "groupId": "group127-8545-4463-603b-04d550d23bf",6      "groupName": "グループ1",7      "description": "ドメイングループ",8      "visible": true,9      "useServiceNotification": true,10      "serviceManageable": true,11      "groupExternalKey": "GROUP_EXT_01",12      "administrators": [13        {14          "userExternalKey": "USER_EXT_01",15          "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"16        }17      ],18      "members": [19        {20          "externalKey": "USER_EXT_01",21          "id": "userf7da-f82c-4284-13e7-030f3b4c756x",22          "type": "USER"23        },24        {25          "externalKey": "ORGUNIT_EXT_01",26          "id": "orgunitf-f27f-4af8-27e1-03817a911417",27          "type": "ORGUNIT"28        },29        {30          "externalKey": "GROUP_EXT_01",31          "id": "group769-e656-477d-69c7-04e2f73a4a77",32          "type": "GROUP"33        }34      ],35      "useMessage": true,36      "useNote": true,37      "useCalendar": true,38      "useFolder": true,39      "useTask": true,40      "useMail": true,41      "groupEmail": "group01@example.com",42      "aliasEmails": [43        "alias@example.com"44      ],45      "canReceiveExternalMail": true,46      "toExternalEmails": [47        "external@example.com"48      ],49      "membersAllowedToUseGroupEmailAsRecipient": [50        {51          "userExternalKey": "USER_EXT_01",52          "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"53        }54      ],55      "membersAllowedToUseGroupEmailAsSender": [56        {57          "userExternalKey": "USER_EXT_01",58          "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"59        }60      ]61    },62    {63      "domainId": 10000001,64      "groupId": "groupa36-79c8-4858-6c23-041098774484",65      "groupName": "グループ2",66      "visible": false,67      "useServiceNotification": true,68      "serviceManageable": true,69      "groupExternalKey": "GROUP_EXT_02",70      "administrators": [71        {72          "userExternalKey": "USER_EXT_02",73          "userId": "user6362-21a9-1kbc-1234-126e09fcegd1"74        }75      ],76      "members": [77        {78          "externalKey": "USER_EXT_01",79          "id": "userf7da-f82c-4284-13e7-030f3b4c756x",80          "type": "USER"81        },82        {83          "externalKey": "ORGUNIT_EXT_02",84          "id": "orgunit7-f511-4757-6040-044af9c9742d",85          "type": "ORGUNIT"86        }87      ],88      "useMessage": true,89      "useNote": true,90      "useCalendar": true,91      "useFolder": true,92      "useTask": true,93      "useMail": true,94      "groupEmail": "group02@example.com",95      "aliasEmails": [96        "alias2@example.com"97      ],98      "canReceiveExternalMail": false99    }100  ],101  "responseMetaData": {102    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="103  }104}