組織照会
組織を照会します。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/orgunits/{externalKey}
HTTP Method
GET
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID | |
externalKey | String | 100 字 | Y | 組織の External Key |
Request Parameters
Request Body
Request Example
GET https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/orgunits/EX123
Response
パラメーター | タイプ | 説明 |
---|---|---|
domainId | Integer | ドメイン ID |
externalKey | String | 組織の External Key |
parentExternalKey | String | 上位組織の External Key |
name | String | 組織名 |
i18nNames[] | List | 多言語名リスト |
i18nNames[].language | String | 多言語コード 付録の言語/タイムゾーンコード参照。 |
i18nNames[].name | String | 多言語名 |
String | 組織メールアドレス ● アドバンスト/ベーシック/プレミアムプランで利用している場合には、メールアドレスと同じ。 ● 他のプランで利用している場合には、ID@グループ名。 |
|
description | String | 組織の説明 |
display | Boolean | 組織の公開有無 (true/false) |
level | Integer | 組織の階層 (depth, 1から開始) |
order | Integer | 上位組織が同じ組織の並び順 A └ A1 (A 基準 order 1) └ A2 (A 基準 order 2) B └ B1 (B 基準 order 1) └ B2 (B 基準 order 2) |
aliasEmails | List | 組織のサブメールアドレスリスト |
receiveExternalMail | Boolean | 外部メール受信可否 |
messageUse | Boolean | チームトークルームの利用有無 |
noteUse | Boolean | チームノートの利用有無 ● チームトークルーム利用時に利用可 |
calendarUse | Boolean | チームカレンダーの利用有無 ● チームトークルーム利用時に利用可 |
folderUse | Boolean | チームフォルダの利用有無 ● チームトークルーム利用時に利用可 |
serviceAlarm | Boolean | サービス通知の送信有無 |
membersToReceiveFrom[] | List | このメーリングリストにメールを送信可能なメンバーリスト ● 指定されたメンバーのメールのみ受信 |
membersToReceiveFrom[].domainId | Integer | メンバーのドメイン ID |
membersToReceiveFrom[].externalKey | String | メンバーの External Key |
membersToSendout[] | List | メーリングリストを送信アドレスとして使用可能なメンバーのリスト ● 組織の所属メンバーのみ指定可 (それ以外を指定した場合には自動的にリストから除外) |
membersToSendout[].domainId | Integer | メンバーのドメイン ID |
membersToSendout[].externalKey | String | メンバーの External Key |
Response Example
{
"domainId": 123,
"externalKey": "ABC123",
"parentExternalKey": "PPP123",
"name": "ORG1",
"i18nNames": [
{
"language": "en_US",
"name": "ORG1_en"
}
],
"email": "org1@test.com",
"description": "ABC123 description",
"display": true,
"level" : 2,
"order" : 3,
"aliasEmails" : ["alias1@test.com", "aslias2@test.com"],
"receiveExternalMail": true,
"messageUse": true,
"noteUse": true,
"calendarUse": false,
"folderUse": false,
"serviceAlarm": false,
"membersToReceiveFrom": [{
"domainId": 123,
"externalKey": "USER001"
}],
"membersToSendout": [{
"domainId": 123,
"externalKey": "USER001"
}]
}
Error code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST API エラーコードを参照してください。