{{< details >}}
- Tier: 基础版, 专业版, 旗舰版
- Offering: JihuLab.com, 私有化部署
{{< /details >}}
使用此 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
}
]
列出用户的所有电子邮件地址
{{< details >}}
- Tier: 基础版, 专业版, 旗舰版
- Offering: 私有化部署
{{< /details >}}
列出给定用户账户的所有电子邮件地址。
先决条件:
- 您必须对该实例具有管理员访问权限。
GET /users/:id/emails
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer | yes | 用户账户的 ID |
获取电子邮件地址的详细信息
获取您用户账户中给定电子邮件地址的详细信息。
GET /user/emails/:email_id
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
email_id |
integer | yes | 电子邮件地址的 ID |
示例响应:
{
"id": 1,
"email": "email@example.com",
"confirmed_at" : "2021-03-26T19:07:56.248Z"
}
添加电子邮件地址
为您的用户账户添加电子邮件地址。
POST /user/emails
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
email |
string | yes | 电子邮件地址 |
{
"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"
]
}
}
为用户添加电子邮件地址
{{< details >}}
- Tier: 基础版, 专业版, 旗舰版
- Offering: 私有化部署
{{< /details >}}
为给定用户账户添加电子邮件地址。
先决条件:
- 您必须对该实例具有管理员访问权限。
POST /users/:id/emails
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
string | yes | 用户账户的 ID |
email |
string | yes | 电子邮件地址 |
skip_confirmation |
boolean | no | 跳过确认并假定电子邮件已验证。可能的值:true ,false 。默认值:false 。 |
删除电子邮件地址
删除您的用户账户的电子邮件地址。您不能删除主要电子邮件地址。
任何发送到被删除的电子邮件地址的未来邮件将发送到主要电子邮件地址。
先决条件:
- 您必须经过身份验证。
DELETE /user/emails/:email_id
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
email_id |
integer | yes | 电子邮件地址的 ID |
返回:
- 如果操作成功,则返回
204 No Content
。 - 如果资源未找到,则返回
404
。
删除用户的电子邮件地址
{{< details >}}
- Tier: 基础版, 专业版, 旗舰版
- Offering: 私有化部署
{{< /details >}}
删除给定用户账户的电子邮件地址。您不能删除主要电子邮件地址。
先决条件:
- 您必须对该实例具有管理员访问权限。
DELETE /users/:id/emails/:email_id
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer | yes | 用户账户的 ID |
email_id |
integer | yes | 电子邮件地址的 ID |