組織の部分更新

PATCH/orgunits/{orgUnitId}

組織を部分更新する。

注意

  • 組織の登録/更新/部分更新/移動 API は、1ドメインにつき必ずシングルスレッドで1秒に1回、順番通りに呼び出すことを推奨します。
  • 組織の移動は、組織の移動を使用します。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

directory
orgunit

HTTP Request

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

Path Parameters

ParameterTypeDescription
orgUnitIdstring

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

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

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

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required
Content-Typestring

application/json


required
example : application/json

Request Body

PropertyTypeDescription
domainIdinteger

ドメインID


format : int32
orgUnitExternalKeystring

組織のExternalKey

「%」、「\」、「#」、「/」、「?」の特殊文字は利用不可。


maxLength : 100
nullable : true
orgUnitNamestring

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


maxLength : 100
i18nNamesarray (OrgUnitI18nName)

多言語名リスト

emailstring

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

  • アドバンスト/ベーシック/プレミアムプランの場合、ID@ドメイン名
  • 他のプランの場合、ID@グループ名
  • 80字まで入力できる
  • localPartは64字まで入力できる

maxLength : 90
descriptionstring

組織説明


maxLength : 160
nullable : true
visibleboolean

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

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

default : true
aliasEmailsarray (string)

組織のサブメールアドレスのリスト(アドバンスト/ベーシック/プレミアムプランのみ登録できる)


minItems : 0
maxItems : 20
canReceiveExternalMailboolean

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


default : false
useMessageboolean

チームトークルームの利用フラグ


default : false
useNoteboolean

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


default : false
useCalendarboolean

チームカレンダーの利用フラグ
チームトーク利用時のみ利用できる


default : false
useTaskboolean

チームタスクの利用フラグ
チームトーク利用時のみ利用可能


default : false
useFolderboolean

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


default : false
useServiceNotificationboolean

サービス通知送信フラグ


default : false
membersAllowedToUseOrgUnitEmailAsRecipientarray (OrgUnitAllowedMember)

組織メールアドレスでメールを受信可能なメンバーのリスト


minItems : 0
membersAllowedToUseOrgUnitEmailAsSenderarray (OrgUnitAllowedMember)

送信アドレスとして使用可能なメンバーのリスト


minItems : 0

OrgUnitI18nName

PropertyTypeDescription
languagestring

多言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
namestring

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


required
maxLength : 100

OrgUnitAllowedMember

PropertyTypeDescription
userIdstring

ユーザーID(userId)


required

Request Example

example

1{
2  "domainId": 10000001,
3  "orgUnitName": "組織01",
4  "visible": true
5}

Response

HTTP 200

OK

PropertyTypeDescription
domainIdinteger

ドメインID


required
format : int32
orgUnitIdstring

組織ID

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

readOnly : true
orgUnitExternalKeystring

組織のExternalKey

「%」、「\」、「#」、「/」、「?」の特殊文字は利用不可。


maxLength : 100
nullable : true
orgUnitNamestring

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


required
maxLength : 100
i18nNamesarray (OrgUnitI18nName)

多言語名リスト

emailstring

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

  • アドバンスト/ベーシック/プレミアムプランの場合、ID@ドメイン名
  • 他のプランの場合、ID@グループ名
  • 90字まで入力可能
  • localPartは64字まで入力可能

maxLength : 90
descriptionstring

組織説明


maxLength : 160
nullable : true
visibleboolean

組織公開フラグ


default : true
parentOrgUnitIdstring

上位組織ID

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

nullable : true
parentExternalKeystring

上位組織のExternalKey


readOnly : true
nullable : true
displayOrderinteger

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

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


minimum : 1
format : int32
displayLevelinteger

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


minimum : 1
format : int32
readOnly : true
aliasEmailsarray (string)

組織のサブメールアドレスのリスト(アドバンスト/ベーシック/プレミアムプランのみ登録可)


minItems : 0
maxItems : 20
canReceiveExternalMailboolean

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


default : false
useMessageboolean

チームトークルームの利用フラグ


default : false
useNoteboolean

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


default : false
useCalendarboolean

チームカレンダーの利用フラグ
チームトーク利用時のみ利用できる


default : false
useTaskboolean

チームタスクの利用フラグ
チームトーク利用時のみ利用可能


default : false
useFolderboolean

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


default : false
useServiceNotificationboolean

サービス通知送信フラグ


default : false
membersAllowedToUseOrgUnitEmailAsRecipientarray (OrgUnitAllowedMember)

組織メールアドレス宛にメールを送信可能なメンバーのリスト


minItems : 0
membersAllowedToUseOrgUnitEmailAsSenderarray (OrgUnitAllowedMember)

組織メールアドレスを送信元としてメールを送信可能なメンバーのリスト
組織のメンバーのみを指定可能


minItems : 0

OrgUnitI18nName

PropertyTypeDescription
languagestring

多言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
namestring

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


required
maxLength : 100

OrgUnitAllowedMember

PropertyTypeDescription
userIdstring

ユーザーID(userId)


required
userExternalKeystring

ユーザーの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": null
33    }
34  ],
35  "membersAllowedToUseOrgUnitEmailAsSender": [
36    {
37      "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",
38      "userExternalKey": null
39    }
40  ]
41}

HTTP 400

Bad Request

HTTP 404

Not Found