GET/directory/user-types/external-keys

利用権限タイプの ExternalKey リストを取得する。

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/user-types/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
userTypes array (DomainUniqueExternalKeyResponse) 

利用権限タイプの ExternalKey リスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

DomainUniqueExternalKeyResponse

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32
readOnly : true 
name string 

名前


readOnly : true 
id string 

リソースを特定する ID


readOnly : true 
externalKey string 

ExternalKey


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "userTypes": [3    {4      "domainId": 10000001,5      "name": "name01",6      "id": "employ2c-f321-47a6-ac11-e81fcc23a8c3",7      "externalKey": "USERTYPE_EXT_01"8    },9    {10      "domainId": 10000001,11      "name": "name02",12      "id": "employ0f-997b-4f47-9267-463f15e908a3",13      "externalKey": "USERTYPE_EXT_02"14    }15  ],16  "responseMetaData": {17    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="18  }19}