PUT/orgunits/{orgUnitId}

組織情報を更新する。

注意

  • useMessage を false に設定すると、useNote、useTask、useCalendar、useFolder も連動して false に設定されます。
  • useMessage、useNote、useTask、useCalendar、useFolder は default: false のため、パラメータ名を間違えたり、指定しなかった場合にも機能は無効化されます。そのため、組織情報を更新する際には 組織の部分更新 の利用を推奨します。
  • 組織の登録/更新/部分更新/移動/削除 API は、1 ドメインにつき必ずシングルスレッドで、1 秒以上の間隔を開け、順番に呼び出すことを推奨します。
  • 組織の移動は、組織の移動 を使用します。

Authorization

oauth2

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

Scope

directory
orgunit

HTTP Request

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

Path Parameters

ParameterTypeDescription
orgUnitId string 

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

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

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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
orgUnitExternalKey string 

組織のExternalKey "%"、"\"、"#、"/"、"?" の特殊文字は利用不可。


maxLength : 100
nullable : true 
orgUnitName string 

組織名
許容される特殊文字: !@&()-_+[]{},./


maxLength : 100 
i18nNames array (OrgUnitI18nName) 

多言語名リスト

 
email string 

組織メールアドレス (組織を更新する際は必須)

  • アドバンストプランの場合、ID@ドメイン名
  • 他のプランの場合、ID@グループ名
  • 90 字まで入力できる
  • localPart は 64 字まで入力できる

maxLength : 90 
description string 

組織説明


maxLength : 160
nullable : true 
visible boolean 

組織の公開可否 (true/false)

  • false に設定すると下位組織も非公開 (false) に切り替わる。
  • true に設定すると上位組織も公開 (true) に切り替わる。

default : true 
aliasEmails array (string) 

組織のサブメールアドレスのリスト (アドバンストプランのみ登録できる)


minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

外部メールの受信可否フラグ


default : false 
useMessage boolean 

トークの利用フラグ

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

default : false 
useNote boolean 

ノートの利用フラグ
トーク利用時のみ利用できる


default : false 
useCalendar boolean 

予定の利用フラグ
トーク利用時のみ利用できる


default : false 
useTask boolean 

タスクの利用フラグ
トーク利用時のみ利用できる


default : false 
useFolder boolean 

フォルダの利用フラグ
トーク利用時のみ利用できる


default : false 
useServiceNotification boolean 

サービス通知送信フラグ


default : false 
membersAllowedToUseOrgUnitEmailAsRecipient array (OrgUnitAllowedMember) 

組織のメーリングリストアドレスにメールを送信できるメンバーのリスト


minItems : 0 
membersAllowedToUseOrgUnitEmailAsSender array (OrgUnitAllowedMember) 

組織のメーリングリストアドレスを送信メールアドレスとして使用できるメンバーのリスト
組織のメンバーのみを指定可能


minItems : 0 

OrgUnitI18nName

PropertyTypeDescription
language string 

多言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
name string 

多言語名
許容される特殊文字: !@&()-_+[]{},./


required
maxLength : 100 

OrgUnitAllowedMember

PropertyTypeDescription
userId string 

ユーザー ID (userId)


required 

Request Example

example

1{2  "domainId": 10000001,3  "orgUnitName": "組織01",4  "email": "team01@example.com",5  "visible": true,6  "canReceiveExternalMail": true,7  "useMessage": true,8  "useNote": true,9  "useCalendar": true,10  "useTask": true,11  "useFolder": true,12  "useServiceNotification": true,13  "displayOrder": 114}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
orgUnitId string 

組織ID

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

readOnly : true 
orgUnitExternalKey string 

組織の ExternalKey "%"、"\"、"#、"/"、"?" の特殊文字は利用不可。


maxLength : 100
nullable : true 
orgUnitName string 

組織名
許容される特殊文字: !@&()-_+[]{},./


required
maxLength : 100 
i18nNames array (OrgUnitI18nName) 

多言語名リスト

 
email string 

組織メールアドレス (組織を更新する際は必須)

  • アドバンストプランの場合、localpart@ドメイン名
  • 他のプランの場合、localpart@グループ名
  • 90 字まで入力可能
    localpart の制限
  • 2～64 字の英小文字、数字、ドット(".")、ハイフン("-")、アンダーバー("_")、エクスクラメーションマーク("!")、ハッシュマーク ("#") のみ使用できる
  • 最初の文字は英小文字、数字、エクスクラメーションマーク ("!")、ハッシュマーク ("#") のみ使用できる
  • ドット (".") は最初と最後、および連続("..") では使用できない

maxLength : 90 
description string 

組織説明


maxLength : 160
nullable : true 
visible boolean 

組織公開フラグ


default : true 
parentOrgUnitId string 

上位組織 ID

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

nullable : true 
parentExternalKey string 

上位組織の ExternalKey


readOnly : true
nullable : true 
displayOrder integer 

組織の表示順
組織を登録する場合のみ必須
組織を更新する場合は無効

A
└ A1 (A 基準 displayOrder 1)
└ A2 (A 基準 displayOrder 2)
B
└ B1 (B 基準 displayOrder 1)
└ B2 (B 基準 displayOrder 2)


minimum : 1
format : int32 
displayLevel integer 

組織の階層 (depth, 1 から開始)


minimum : 1
format : int32
readOnly : true 
aliasEmails array (string) 

組織のサブメールアドレスのリスト (アドバンストプランのみ登録可)


minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

外部メールの受信可否フラグ


default : false 
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 
useServiceNotification boolean 

サービス通知送信フラグ


default : false 
membersAllowedToUseOrgUnitEmailAsRecipient array (OrgUnitAllowedMember) 

組織のメーリングリストアドレスにメールを送信できるメンバーのリスト


minItems : 0 
membersAllowedToUseOrgUnitEmailAsSender array (OrgUnitAllowedMember) 

組織のメーリングリストアドレスを送信メールアドレスとして使用できるメンバーのリスト
組織のメンバーのみを指定可能


minItems : 0 

OrgUnitI18nName

PropertyTypeDescription
language string 

多言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
name string 

多言語名
許容される特殊文字: !@&()-_+[]{},./


required
maxLength : 100 

OrgUnitAllowedMember

PropertyTypeDescription
userId string 

ユーザー ID (userId)


required 
userExternalKey string 

ユーザーの ExternalKey


readOnly : true
nullable : true 

Response Example

example

1{2  "domainId": 10000001,3  "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",4  "orgUnitExternalKey": "externalKeyValue",5  "orgUnitName": "組織01",6  "i18nNames": [7    {8      "language": "en_US",9      "name": "Team01"10    }11  ],12  "email": "team01@example.com",13  "description": "desc",14  "visible": true,15  "parentOrgUnitId": "parernt9-ffda-4395-24a8-03fb9e22e051",16  "parentExternalKey": "parentExtKeyValue",17  "displayOrder": 1,18  "displayLevel": 1,19  "aliasEmails": [20    "alias@example.com"21  ],22  "canReceiveExternalMail": true,23  "useMessage": true,24  "useNote": true,25  "useCalendar": true,26  "useTask": true,27  "useFolder": true,28  "useServiceNotification": true,29  "membersAllowedToUseOrgUnitEmailAsRecipient": [30    {31      "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",32      "userExternalKey": null33    }34  ],35  "membersAllowedToUseOrgUnitEmailAsSender": [36    {37      "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",38      "userExternalKey": null39    }40  ]41}

HTTP 400

Bad Request

HTTP 404

Not Found