POST/users/send-invitation-email

下記のすべての条件に該当するユーザーに対し、招待メールを再送する。

  • ステータスが 登録待ち のユーザー
  • ユーザーのパラメータ パスワード作成方法 (passwordCreationType) を ユーザー (MEMBER) で追加したユーザー
  • 個人メールアドレスが設定されているユーザー
    再送メールの招待者は、最高管理者。
    この API は 1 日に 1 度だけ呼び出すことができる。

Authorization

oauth2

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

Scope

user
directory

HTTP Request

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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
resultEmailReceiver string 

招待メールの送信結果を受信するメールアドレス
この値が空の場合、最高管理者のメールアドレスに結果が送信される。


maxLength : 256 
domainId integer 

ドメイン ID
この値が空の場合、認可元のドメインのドメイン ID が設定される。


format : int32 

Request Example

example

1{2  "resultEmailReceiver": "admin@example.com",3  "domainId": 100000014}

Response

HTTP 202

Accepted

HTTP 400

Bad Request