Help us learn about your current experience with the documentation. Take the survey.

用户邮箱地址 API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

使用此 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
  }
]

列出用户的所有邮箱地址

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab Self-Managed, GitLab Dedicated

列出指定用户账户的所有邮箱地址。

前提条件：

  • 您必须拥有实例的管理员权限。
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"
    ]
  }
}

为用户添加邮箱地址

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab Self-Managed, GitLab Dedicated

为指定用户账户添加邮箱地址。

前提条件：

  • 您必须拥有实例的管理员权限。
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。

删除用户的邮箱地址

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab Self-Managed, GitLab Dedicated

删除指定用户账户的邮箱地址。您不能删除主邮箱地址。

前提条件：

  • 您必须拥有实例的管理员权限。
DELETE /users/:id/emails/:email_id

支持的属性：

属性 类型 必需 描述
id integer yes 用户账户 ID
email_id integer yes 邮箱地址 ID