POST/users/external-keys

ユーザーの ExternalKey を一括登録する。

Authorization

oauth2

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

Scope

directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/external-keys

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
users array (TenantUniqueExternalKeyRequest) 

externalKey のリスト


required
minItems : 1
maxItems : 50 

TenantUniqueExternalKeyRequest

PropertyTypeDescription
id string 

リソースを特定する ID

  • リソース ID
  • リソースのメールアドレス
  • リソースの ExternalKey (externalKey:{resourceExternalKey})
    登録/更新/削除の際に指定する。

required 
externalKey string 

ExternalKey

  • externalKey が既に登録されていない場合には登録
  • externalKey が既に登録されている場合には上書き
  • externalKey に NULL が指定された場合には削除
  • 最大 100 文字
  • 許容されない特殊文字: %#/?

maxLength : 100 

Request Example

example

1{2  "users": [3    {4      "id": "userf7da-f82c-4284-13e7-030f3b4c756x",5      "externalKey": "USER_EXT_01"6    },7    {8      "id": "user6362-21a9-1kbc-1234-126e09fcegd1",9      "externalKey": "USER_EXT_02"10    }11  ]12}

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict