PATCH/groups/{groupId}

グループを部分更新する。

注意

  • 外部グループは更新できません。
  • useMessage を false に設定すると、useNote、useTask、useCalendar、useFolder も連動して false に設定されます。

Authorization

oauth2

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

Scope

directory
group

HTTP Request

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

Path Parameters

ParameterTypeDescription
groupId string 

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

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

required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32 
groupName string 

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


maxLength : 100 
description string 

グループ説明


maxLength : 300
nullable : true 
visible boolean 

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

 
useServiceNotification boolean 

サービス通知送信フラグ

 
serviceManageable boolean 

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

 
groupExternalKey string 

グループの ExternalKey

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

maxLength : 100
nullable : true 
administrators array (GroupAdministrator) 

グループマスターリスト


minItems : 1 
members array (GroupMember) 

グループメンバーリスト

 
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 は必須
 
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 

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

 
toExternalEmails array (string) 

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


minItems : 0
maxItems : 500 
membersAllowedToUseGroupEmailAsRecipient array (GroupAllowedMember) 

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


minItems : 0 
membersAllowedToUseGroupEmailAsSender array (GroupAllowedMember) 

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


minItems : 0 

GroupAdministrator

PropertyTypeDescription
userId string 

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

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

required 

GroupMember

PropertyTypeDescription
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
userId string 

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

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

required 

Request Example

example

1{2  "domainId": 10000001,3  "groupName": "グループ1",4  "useServiceNotification": true,5  "serviceManageable": true,6  "groupExternalKey": "GROUP_EXT_01",7  "administrators": [8    {9      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"10    }11  ],12  "useMessage": false,13  "useNote": false,14  "useCalendar": false,15  "useFolder": false,16  "useTask": false,17  "useMail": true,18  "groupEmail": "email@example.com",19  "canReceiveExternalMail": true,20  "toExternalEmails": [21    "external@example.com"22  ],23  "membersAllowedToUseGroupEmailAsRecipient": []24}

Response

HTTP 200

OK

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 

Response Example

example

1{2  "domainId": 10000001,3  "groupId": "group127-8545-4463-603b-04d550d23bf",4  "groupName": "グループ1",5  "description": "ドメイングループ",6  "visible": true,7  "useServiceNotification": true,8  "serviceManageable": true,9  "groupExternalKey": "GROUP_EXT_01",10  "administrators": [11    {12      "userExternalKey": "USER_EXT_01",13      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"14    }15  ],16  "members": [17    {18      "externalKey": "USER_EXT_01",19      "id": "userf7da-f82c-4284-13e7-030f3b4c756x",20      "type": "USER"21    },22    {23      "externalKey": "ORGUNIT_EXT_01",24      "id": "orgunitf-f27f-4af8-27e1-03817a911417",25      "type": "ORGUNIT"26    },27    {28      "externalKey": "GROUP_EXT_01",29      "id": "group769-e656-477d-69c7-04e2f73a4a77",30      "type": "GROUP"31    }32  ],33  "useMessage": true,34  "useNote": true,35  "useCalendar": true,36  "useFolder": true,37  "useTask": true,38  "useMail": true,39  "groupEmail": "email@example.com",40  "aliasEmails": [41    "alias@example.com"42  ],43  "canReceiveExternalMail": true,44  "toExternalEmails": [45    "external@example.com"46  ],47  "membersAllowedToUseGroupEmailAsRecipient": [48    {49      "userExternalKey": "USER_EXT_01",50      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"51    }52  ],53  "membersAllowedToUseGroupEmailAsSender": [54    {55      "userExternalKey": "USER_EXT_01",56      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"57    }58  ]59}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 409

Conflict