組織の登録

POST/orgunits

組織を登録する。

注意

  • 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

POSThttps://www.worksapis.com/v1.0/orgunits

Header Parameters

HeadertypeDescription
AuthorizationstringBearer {token}
required
Content-Typestringapplication/json
required
example : application/json

Request Body

PropertyTypeDescription
domainIdintegerドメインID
required
orgUnitIdstring組織ID - 組織のリソースID - 登録時に自動発行されるユニークID
readOnly : true
orgUnitExternalKeystring組織のExternalKey
orgUnitNamestring組織名 許容される特殊文字: !@&()-_+[]{},./
required
maxLength : 100
i18nNamesarray (OrgUnitI18nName)多言語名リスト
emailstring組織メールアドレス(組織を更新する際は必須) - ベーシック/プレミアムプランの場合、ID@ドメイン名 - ライトプランの場合、ID@グループ名
descriptionstring組織説明
maxLength : 160
visibleboolean組織公開フラグ
required
parentOrgUnitIdstring上位組織ID
parentExternalKeystring上位組織のExternalKey
readOnly : true
displayOrderinteger組織の表示順(組織を登録する場合のみ必須) A └ A1 (A 基準 displayOrder 1) └ A2 (A 基準 displayOrder 2) B └ B1 (B 基準 displayOrder 1) └ B2 (B 基準 displayOrder 2)
minimum : 1
aliasEmailsarray (string)組織のサブメールアドレスのリスト(ベーシック/プレミアムプランのみ登録可)
useExternalMailboolean外部メールの受信可否フラグ
default : false
useMessagebooleanチームトークルームの利用フラグ
default : false
useNotebooleanチームノートの利用フラグ チームトーク利用時のみ利用可能
default : false
useCalendarbooleanチームカレンダーの利用フラグ チームトーク利用時のみ利用可能
default : false
useFolderbooleanチームフォルダの利用フラグ チームトーク利用時のみ利用可能
default : false
useServiceNotificationbooleanサービス通知送信フラグ
default : false
membersAllowedToUseOrgUnitEmailAsRecipientarray (OrgUnitAllowedMember)組織メールアドレスでメールを受信可能なメンバーのリスト
membersAllowedToUseOrgUnitEmailAsSenderarray (OrgUnitAllowedMember)送信アドレスとして使用可能なメンバーのリスト
displayLevelinteger組織の階層(depth, 1から開始)
minimum : 1
readOnly : true

OrgUnitI18nName

PropertyTypeDescription
languagestring多言語コード
required
enum : ja_JP, ko_KR, en_US, zh_CN, zh_TW
namestring多言語名 許容される特殊文字: !@&()-_+[]{},./
required
maxLength : 100

OrgUnitAllowedMember

PropertyTypeDescription
domainIdintegerユーザーのドメインID
readOnly : true
userExternalKeystringユーザーのExternalKey
readOnly : true
userIdstringユーザーID(userId)
required

Request Example

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

Response

HTTP 201

Created

PropertyTypeDescription
domainIdintegerドメインID
required
orgUnitIdstring組織ID - 組織のリソースID - 登録時に自動発行されるユニークID
readOnly : true
orgUnitExternalKeystring組織のExternalKey
orgUnitNamestring組織名 許容される特殊文字: !@&()-_+[]{},./
required
maxLength : 100
i18nNamesarray (OrgUnitI18nName)多言語名リスト
emailstring組織メールアドレス(組織を更新する際は必須) - ベーシック/プレミアムプランの場合、ID@ドメイン名 - ライトプランの場合、ID@グループ名
descriptionstring組織説明
maxLength : 160
visibleboolean組織公開フラグ
required
parentOrgUnitIdstring上位組織ID
parentExternalKeystring上位組織のExternalKey
readOnly : true
displayOrderinteger組織の表示順(組織を登録する場合のみ必須) A └ A1 (A 基準 displayOrder 1) └ A2 (A 基準 displayOrder 2) B └ B1 (B 基準 displayOrder 1) └ B2 (B 基準 displayOrder 2)
minimum : 1
aliasEmailsarray (string)組織のサブメールアドレスのリスト(ベーシック/プレミアムプランのみ登録可)
useExternalMailboolean外部メールの受信可否フラグ
default : false
useMessagebooleanチームトークルームの利用フラグ
default : false
useNotebooleanチームノートの利用フラグ チームトーク利用時のみ利用可能
default : false
useCalendarbooleanチームカレンダーの利用フラグ チームトーク利用時のみ利用可能
default : false
useFolderbooleanチームフォルダの利用フラグ チームトーク利用時のみ利用可能
default : false
useServiceNotificationbooleanサービス通知送信フラグ
default : false
membersAllowedToUseOrgUnitEmailAsRecipientarray (OrgUnitAllowedMember)組織メールアドレスでメールを受信可能なメンバーのリスト
membersAllowedToUseOrgUnitEmailAsSenderarray (OrgUnitAllowedMember)送信アドレスとして使用可能なメンバーのリスト
displayLevelinteger組織の階層(depth, 1から開始)
minimum : 1
readOnly : true

OrgUnitI18nName

PropertyTypeDescription
languagestring多言語コード
required
enum : ja_JP, ko_KR, en_US, zh_CN, zh_TW
namestring多言語名 許容される特殊文字: !@&()-_+[]{},./
required
maxLength : 100

OrgUnitAllowedMember

PropertyTypeDescription
domainIdintegerユーザーのドメインID
readOnly : true
userExternalKeystringユーザーのExternalKey
readOnly : true
userIdstringユーザーID(userId)
required

Response Example

1{
2  "domainId": 10000001,
3  "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",
4  "orgUnitName": "組織01",
5  "email": "team01@example.com",
6  "visible": true,
7  "displayOrder": 1,
8  "useExternalMail": true,
9  "useMessage": true,
10  "useNote": true,
11  "useCalendar": true,
12  "useFolder": true,
13  "useServiceNotification": true,
14  "displayLevel": 1
15}

HTTP 400

Bad Request