GET/orgunits/external-keys

組織の ExternalKey リストを取得する。

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/orgunits/external-keys

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== 
hasExternalKey boolean 

externalKey の有無でフィルタする

  • true : externalKey を持つリソースのみ取得します
  • false : externalKey を持たないリソースのみを取得します
  • 指定しない場合には、すべてのリソースを取得します

example : false 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
orgUnits array (TenantUniqueExternalKeyResponse) 

組織の ExternalKey リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

TenantUniqueExternalKeyResponse

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32
readOnly : true 
name string 

名前


readOnly : true 
email string 

メールアドレス


readOnly : true 
id string 

リソースを特定する ID


readOnly : true 
externalKey string 

ExternalKey


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "orgUnits": [3    {4      "domainId": 10000001,5      "name": "組織01",6      "email": "team01@example.com",7      "id": "orgunitf-f27f-4af8-27e1-03817a911417",8      "externalKey": "ORGUNIT_EXT_01"9    },10    {11      "domainId": 10000001,12      "name": "組織02",13      "email": "team02@example.com",14      "id": "orgunit7-f511-4757-6040-044af9c9742d",15      "externalKey": "ORGUNIT_EXT_02"16    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}