ユーザーメールアドレスAPI

ユーザーアカウントのメールアドレスとやり取りするために、このAPIを使用します。詳細については、ユーザーアカウントを参照してください。

すべてのメールアドレスをリスト表示

ユーザーアカウントのすべてのメールアドレスをリスト表示します。

前提条件:

• 認証済みである必要があります。

GET /user/emails

レスポンス例:

[
  {
    "id": 1,
    "email": "email@example.com",
    "confirmed_at" : "2021-03-26T19:07:56.248Z"
  },
  {
    "id": 3,
    "email": "email2@example.com",
    "confirmed_at" : null
  }
]

ユーザーのすべてのメールアドレスをリスト表示

指定したユーザーアカウントのすべてのメールアドレスをリスト表示します。

前提条件:

• インスタンスへの管理者アクセス権が必要です。

GET /users/:id/emails

サポートされている属性は以下のとおりです:

メールアドレスの詳細を取得する

ユーザーアカウントの指定したメールアドレスの詳細を取得します。

GET /user/emails/:email_id

サポートされている属性は以下のとおりです:

レスポンス例:

{
  "id": 1,
  "email": "email@example.com",
  "confirmed_at" : "2021-03-26T19:07:56.248Z"
}

メールアドレスを追加

ユーザーアカウントにメールアドレスを追加します。

POST /user/emails

サポートされている属性は以下のとおりです:

{
  "id": 4,
  "email": "email@example.com",
  "confirmed_at" : "2021-03-26T19:07:56.248Z"
}

成功した場合、ステータス201 Createdのメールが作成され返されます。エラーが発生した場合は、エラーを説明するメッセージとともに400 Bad Requestが返されます:

{
  "message": {
    "email": [
      "has already been taken"
    ]
  }
}

ユーザーのメールアドレスを追加

指定したユーザーアカウントにメールアドレスを追加します。

前提条件:

• インスタンスへの管理者アクセス権が必要です。

POST /users/:id/emails

サポートされている属性は以下のとおりです:

メールアドレスを削除

ユーザーアカウントのメールアドレスを削除します。プライマリメールアドレスは削除できません。

削除されたメールアドレスに送信される将来のメールは、代わりにプライマリメールアドレスに送信されます。

前提条件:

• 認証済みである必要があります。

DELETE /user/emails/:email_id

サポートされている属性は以下のとおりです:

戻り値:

• 操作が成功した場合の204 No Content。
• リソースが見つからなかった場合は404。

ユーザーのメールアドレスを削除

指定したユーザーアカウントのメールアドレスを削除します。プライマリメールアドレスは削除できません。

前提条件:

• インスタンスへの管理者アクセス権が必要です。

DELETE /users/:id/emails/:email_id

サポートされている属性は以下のとおりです: