POST/users/{userId}/send-invitation-email

ステータスが 登録待ち のユーザーに対し、招待メールを再送する。
再送メールの招待者は、最高管理者。

Authorization

oauth2

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

Scope

user
directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/send-invitation-email

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
usePrivateEmail boolean 

保存されている個人メールアドレスへの再送信フラグ
true の場合は保存されている個人メール宛てに送信する。


required
default : false 
email string 

招待メールの送信先メールアドレス
usePrivateEmail が false の場合には必須。


maxLength : 256 

Request Example

example

1{2  "usePrivateEmail": true3}

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found