GET/orgunits

組織リストを取得する。

Authorization

oauth2

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

Scope

directory
directory.read
orgunit
orgunit.read

HTTP Request

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

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
orgUnits array (OrgUnit) 

組織リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

OrgUnit

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 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

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