用户API | GitLab

此外，您可以根据状态筛选用户此路不通和积极的.它不支持活动=假或阻塞=假.

GET/用户？active=真

GET/用户？阻塞=真

此外，您只能使用搜索外部用户外部=真.它不支持外部=错误.

GET/用户？外部=真

GitLab支持机器人程序用户，例如警报机器人程序或支持机器人程序.您可以排除以下类型的内部用户从用户列表中使用exclude_internal=真参数：

通知机器人程序
支持机器人程序

但是，此操作不排除项目的bot用户或组的bot用户.

GET/用户？exclude_internal=真

此外，要从用户列表中排除外部用户，可以使用参数exclude_external=真.

GET/用户？exclude_external=真

排除项目的bot用户和组的bot用户，您可以使用参数without_project_bots=真.

GET/用户？without_project_bots=真

对于管理员

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个创建人（_B）响应中的字段是介绍GitLab 15.6中。
这个scim标识响应中的字段介绍在GitLab 16.1。
这个审计师响应中的字段介绍GitLab 16.2。
这个电子邮件已提供响应中的字段介绍在GitLab 16.7中。

GET/用户

你可以使用所有每个人都可以使用的参数加上这些额外的参数，这些参数只对管理员可用。

属性类型要求的描述

外部_uid 一串不获取具有特定外部身份验证提供程序UID的单个用户。
供应商 一串不外部提供程序。
订单（_B） 一串不退货用户订购人身份证件,名称,用户名,创建_日期，或更新于领域。默认值为身份证件
分类 一串不返回排序的用户asc公司或描述订单。默认值为描述
双因素 一串不通过双因素身份验证筛选用户。过滤器值为启用或禁用。默认情况下，它返回所有用户
无项目 布尔值不筛选没有项目的用户。默认值为假，这意味着返回所有用户，包括项目和不包括项目。
管理员 布尔值不仅返回管理员。默认值为假
审计师 布尔值不仅返回审计师用户。默认值为假。如果不包括在内，则返回所有用户。仅限高级和旗舰版。
样本提供者id 数不仅返回由指定SAML提供程序ID创建的用户。如果不包括，则返回所有用户。仅限高级和旗舰版。
滑雪-ldap 布尔值不跳过LDAP用户。仅限高级和旗舰版。

属性	类型	要求的	描述
`外部_uid`	一串	不	获取具有特定外部身份验证提供程序UID的单个用户。
`供应商`	一串	不	外部提供程序。
`订单（_B）`	一串	不	退货用户订购人`身份证件`,`名称`,`用户名`,`创建_日期`，或`更新于`领域。默认值为`身份证件`
`分类`	一串	不	返回排序的用户`asc公司`或`描述`订单。默认值为`描述`
`双因素`	一串	不	通过双因素身份验证筛选用户。过滤器值为`启用`或`禁用`。默认情况下，它返回所有用户
`无项目`	布尔值	不	筛选没有项目的用户。默认值为`假`，这意味着返回所有用户，包括项目和不包括项目。
`管理员`	布尔值	不	仅返回管理员。默认值为`假`
`审计师`	布尔值	不	仅返回审计师用户。默认值为`假`。如果不包括在内，则返回所有用户。仅限高级和旗舰版。
`样本提供者id`	数	不	仅返回由指定SAML提供程序ID创建的用户。如果不包括，则返回所有用户。仅限高级和旗舰版。
`滑雪-ldap`	布尔值	不	跳过LDAP用户。仅限高级和旗舰版。

[
  {
    “id”: 1,
    “用户名”: “约翰·史密斯”,
    “电子邮件”: "john@example.com",
    “名称”: “约翰·史密斯”,
    “状态”: “活动”,
    “锁定”: 假,
    “化身url”: "http://localhost:3000/uploads/user/avatar/1/index.jpg",
    “网页url”: "http://localhost:3000/john_smith网址",
    “创建日期”: “2012-05-23T08:00:58Z”,
    “is_admin”: 假,
    “生物”: "",
    “位置”: 无效的,
    “skype”: "",
    “linkedin”: "",
    “推特”: "",
    “不和谐”: "",
    “网站url”: "",
    “组织”: "",
    “作业_标题”: "",
    “最后签名日期”: “2012-06-01T11:41:01Z”,
    “确认日期”: “2012-05-23T09:05:22Z”,
    “主题_id”: 1,
    “last_activity_on”: "2012-05-23",
    “颜色方案id”: 2,
    “项目_限制”: 100,
    “当前签名_输入_”: “2012-06-02T06:36:55Z”,
    “备注”: “DMCA请求：2018-11-05 |违反DMCA |滥用|https://gitlab.zendesk.com/agent/tickets/123",
    “身份”: [
      {“提供商”: “github”, “外部_uid”: "2435223452345"},
      {“提供商”: “比特桶”, “外部_uid”: “约翰·史密斯”},
      {“提供商”: “谷歌授权2”, “外部_uid”: "8776128412476123468721346"}
    ],
    “可以创建组”: 真的,
    “可以创建项目”: 真的,
    “双因素启用”: 真的,
    “外部”: 假,
    “私人配置文件”: 假,
    “当前签名_in_ip”: "196.165.1.102",
    “最后签名_输入”: "172.127.2.22",
    “命名空间id”: 1,
    “创建人（_B）”: 无效的,
    “电子邮件_设置_提供_ at”: 无效的
  },
  {
    “id”: 2,
    “用户名”: “杰克史密斯”,
    “电子邮件”: "jack@example.com",
    “名称”: “杰克·史密斯”,
    “状态”: “已阻止”,
    “锁定”: 假,
    “化身url”: "http://localhost:3000/uploads/user/avatar/2/index.jpg",
    “网页url”: "http://localhost:3000/jack_smith",
    “创建日期”: “2012-05-23T08:01:01Z”,
    “is_admin”: 假,
    “生物”: "",
    “位置”: 无效的,
    “skype”: "",
    “linkedin”: "",
    “推特”: "",
    “不和谐”: "",
    “网站url”: "",
    “组织”: "",
    “作业_标题”: "",
    “最后签名日期”: 无效的,
    “确认日期”: “2012-05-30T16:53:06.148Z”,
    “主题_id”: 1,
    “last_activity_on”: "2012-05-23",
    “颜色方案id”: 3,
    “项目_限制”: 100,
    “当前签名_输入_”: “2014-03-19T17:54:13Z”,
    “身份”: [],
    “可以创建组”: 真的,
    “可以创建项目”: 真的,
    “双因素启用”: 真的,
    “外部”: 假,
    “私人配置文件”: 假,
    “当前签名_in_ip”: "10.165.1.102",
    “最后签名_输入”: "172.127.2.22",
    “命名空间id”: 2,
    “创建人（_B）”: 无效的,
    “电子邮件_设置_提供_ at”: 无效的
  }
]

上的用户GitLab Premium或Ultimate另请参见共享跑步者分钟限制,额外共享的runners_minutes_limit,是审核人（_A）、和使用许可证座位参数。

[
  {
    “id”: 1,
    ...
    “shared_runners_minutes_limit”: 133,
    “extra_shared_runners_minutes_limit”: 133,
    “is_auditor”: 假,
    “使用许可证座位”: 真的
    ...
  }
]

上的用户GitLab Premium或Ultimate另请参见这个组saml提供者选项和提供的_ by_group_id参数：

[
  {
    “id”: 1,
    ...
    “身份”: [
      {“提供商”: “github”, “外部_uid”: "2435223452345"},
      {“提供商”: “比特桶”, “外部_uid”: “约翰·史密斯”},
      {“提供商”: “谷歌授权2”, “外部_uid”: "8776128412476123468721346"},
      {“提供商”: “组saml”, “外部_uid”: "123789", “saml_provider_id”: 10}
    ],
    “由_group_id提供”: 123789
    ...
  }
]

您还可以使用?搜索=按名称、用户名或电子邮件搜索用户。例如，/用户？search=约翰。搜索时：

电子邮件，您必须使用完整的电子邮件地址才能获得精确匹配。作为管理员，您可以搜索公共和私人电子邮件地址。
姓名或用户名，您不必获得完全匹配，因为这是一个模糊搜索。

您可以按外部UID和提供程序查找用户：

GET/用户？extern_uid=：extern_auid&provider=：provider

例如：

GET/用户？extern_uid=1234567&provider=github

上的用户GitLab Premium或Ultimate拥有科学情报学提供程序可用：

GET/用户？extern_uid=1234567&provider=scim

您可以使用以下工具按创建日期时间范围搜索用户：

GET/用户？created_before=2001-01-02T00:00:00.060Z&created_after=1999-01-02T_00:00:00：00.060

您可以使用以下选项搜索没有项目的用户：/用户？without_projects=true

您可以按筛选自定义属性具有：

GET/用户？custom_attributes[key]=值&custom_atributes[other_key]=其他值

您可以包括用户的自定义属性在答复中：

GET/用户？with_custom_attributes=true

您可以使用创建人（_B）参数查看是否创建了用户帐户：

由管理员手动执行.
作为一个项目机器人程序用户.

如果返回值为无效的，该帐户是由自己注册帐户的用户创建的。

单个用户

获取单个用户。

对于用户

前提条件：

您必须登录才能使用此终结点。

GET/users/：id

参数：

属性类型要求的描述

身份证件 整数是的用户ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “名称”: “约翰·史密斯”,
  “状态”: “活动”,
  “锁定”: 假,
  “化身url”: "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
  “网页url”: "http://localhost:3000/john_smith网址",
  “创建日期”: “2012-05-23T08:00:58Z”,
  “生物”: "",
  “机器人”: 假,
  “位置”: 无效的,
  “公共电子邮件”: "john@example.com",
  “skype”: "",
  “linkedin”: "",
  “推特”: "",
  “不和谐”: "",
  “网站url”: "",
  “组织”: "",
  “作业_标题”: “运营专家”,
  “代词”: “他/他”,
  “工作信息”: 无效的,
  “关注者”: 1,
  “关注”: 1,
  “本地时间”: “下午3:38”,
  “已跟踪”: 假
}

对于管理员

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个命名空间id响应中的字段是介绍GitLab 14.10中。
这个创建人（_B）响应中的字段是介绍GitLab 15.6中。
这个电子邮件已提供响应中的字段介绍在GitLab 16.7中。

GET/users/：id

参数：

属性类型要求的描述

身份证件 整数是的用户ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID

回答示例：

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “电子邮件”: "john@example.com",
  “名称”: “约翰·史密斯”,
  “状态”: “活动”,
  “锁定”: 假,
  “化身url”: "http://localhost:3000/uploads/user/avatar/1/index.jpg",
  “网页url”: "http://localhost:3000/john_smith网址",
  “创建日期”: “2012-05-23T08:00:58Z”,
  “is_admin”: 假,
  “生物”: "",
  “位置”: 无效的,
  “公共电子邮件”: "john@example.com",
  “skype”: "",
  “linkedin”: "",
  “推特”: "",
  “不和谐”: "",
  “网站url”: "",
  “组织”: "",
  “作业_标题”: “运营专家”,
  “代词”: “他/他”,
  “工作信息”: 无效的,
  “关注者”: 1,
  “关注”: 1,
  “本地时间”: “下午3:38”,
  “最后签名日期”: “2012-06-01T11:41:01Z”,
  “确认日期”: “2012-05-23T09:05:22Z”,
  “主题_id”: 1,
  “last_activity_on”: "2012-05-23",
  “颜色方案id”: 2,
  “项目_限制”: 100,
  “当前签名_输入_”: “2012-06-02T06:36:55Z”,
  “备注”: “DMCA请求：2018-11-05 |违反DMCA |滥用|https://gitlab.zendesk.com/agent/tickets/123",
  “身份”: [
    {“提供商”: “github”, “外部_uid”: "2435223452345"},
    {“提供商”: “比特桶”, “外部_uid”: “约翰·史密斯”},
    {“提供商”: “谷歌授权2”, “外部_uid”: "8776128412476123468721346"}
  ],
  “可以创建组”: 真的,
  “可以创建项目”: 真的,
  “双因素启用”: 真的,
  “外部”: 假,
  “私人配置文件”: 假,
  “提交电子邮件”: "john-codes@example.com",
  “当前签名_in_ip”: "196.165.1.102",
  “最后签名_输入”: "172.127.2.22",
  “计划”: “黄金”,
  “试验”: 真的,
  “签名_计数”: 1337,
  “命名空间id”: 1,
  “创建人（_B）”: 无效的,
  “电子邮件_设置_提供_ at”: 无效的
}

这个计划和试验参数仅在GitLab Enterprise Edition上可用。

上的用户GitLab Premium或Ultimate另请参见这个共享跑步者分钟限制,是审核人（_A）、和额外共享的runners_minutes_limit参数。

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “is_auditor”: 假,
  “shared_runners_minutes_limit”: 133,
  “extra_shared_runners_minutes_limit”: 133,
  ...
}

上的用户GitLab.com Premium或Ultimate也请参阅组saml选项和提供的_ by_group_id参数：

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “shared_runners_minutes_limit”: 133,
  “extra_shared_runners_minutes_limit”: 133,
  “身份”: [
    {“提供商”: “github”, “外部_uid”: "2435223452345"},
    {“提供商”: “比特桶”, “外部_uid”: “约翰·史密斯”},
    {“提供商”: “谷歌授权2”, “外部_uid”: "8776128412476123468721346"},
    {“提供商”: “组saml”, “外部_uid”: "123789", “saml_provider_id”: 10}
  ],
  “由_group_id提供”: 123789
  ...
}

上的用户GitLab.com Premium或Ultimate也请参阅scim标识参数：

{
  ...
  “extra_shared_runners_minutes_limit”: 无效的,
  “scim_identities”: [
      {“外部_uid”: "2435223452345", “组id”: "3", “活动”: 真的},
      {“外部_uid”: “约翰·史密斯”, “组id”: "42", “活动”: 假}
    ]
  ...
}

管理员可以使用创建人（_B）参数查看是否创建了用户帐户：

由管理员手动执行.
作为一个项目机器人程序用户.

如果返回值为无效的，该帐户是由自己注册帐户的用户创建的。

您可以包括用户的自定义属性在答复中：

GET/users/：id？with_custom_attributes=true

用户创建

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个命名空间id响应中的字段是介绍GitLab 14.10中。
创建审计师用户的能力是介绍GitLab 15.3中。

创建新用户。注意，只有管理员才能创建新的用户。要么密码,重置密码，或强制随机密码必须指定。如果重置密码和强制随机密码是二者都假，然后密码是必需的。

强制随机密码和重置密码优先考虑结束密码此外，重置密码和强制随机密码可以一起使用。

私人配置文件默认为默认情况下，将新用户的配置文件设置为私有设置。生物默认为""而不是无效的.

POST/用户

参数：

属性要求的描述

管理员 否用户是管理员。有效值为真的或假。默认为false。
审计师 否用户是审计师。有效值为真的或假。默认为false。介绍GitLab 15.3中。仅限高级和旗舰版。
化身 否用户头像的图像文件
生物 否用户简介
可以创建组 否用户可以创建顶级组-true或false
颜色方案id 否文件查看器的用户配色方案（有关详细信息，请参阅用户首选项文档)
提交电子邮件（_E） 否用户的提交电子邮件地址
电子邮件 是的电子邮件
外部_uid 否外部UID
外部的 否将用户标记为外部-true或false（默认）
额外共享的runners_minutes_limit 否只能由管理员设置。此用户的额外计算分钟数。仅限高级和旗舰版。
强制随机密码 否将用户密码设置为随机值-true或false（默认）
用于saml的组 否配置SAML的组的ID
链接（linkedin） 否 LinkedIn链接
位置 否用户的位置
名称 是的姓名
笔记 否此用户的管理员注释
组织 否组织名称
密码 否密码
私人配置文件 否用户的配置文件是私有的-true或false。默认值由这设置。
项目_限制 否用户可以创建的项目数
代词 否用户的代词
供应商 否外部提供程序名称
公共电子邮件 否用户的公共电子邮件地址
重置密码 否发送用户密码重置链接-true或false（默认）
共享跑步者分钟限制 否只能由管理员设置。此用户的最大每月计算分钟数。可以是无（默认值；继承系统默认值），0（无限制），或> 0。仅限高级和旗舰版。
跳过_确认 否跳过确认-true或false（默认）
skype 否 Skype ID
主题_id 否用户的GitLab主题（有关更多信息，请参阅用户首选项文档更多信息）
推特 否 X（前推特）帐户
不和谐 否不一致账户
用户名 是的用户名
查看difs_file_by_file 否指示用户每页只看到一个文件差异的标志
网站url 否网站地址

属性	要求的	描述
`管理员`	否	用户是管理员。有效值为`真的`或`假`。默认为false。
`审计师`	否	用户是审计师。有效值为`真的`或`假`。默认为false。介绍GitLab 15.3中。仅限高级和旗舰版。
`化身`	否	用户头像的图像文件
`生物`	否	用户简介
`可以创建组`	否	用户可以创建顶级组-true或false
`颜色方案id`	否	文件查看器的用户配色方案（有关详细信息，请参阅用户首选项文档)
`提交电子邮件（_E）`	否	用户的提交电子邮件地址
`电子邮件`	是的	电子邮件
`外部_uid`	否	外部UID
`外部的`	否	将用户标记为外部-true或false（默认）
`额外共享的runners_minutes_limit`	否	只能由管理员设置。此用户的额外计算分钟数。仅限高级和旗舰版。
`强制随机密码`	否	将用户密码设置为随机值-true或false（默认）
`用于saml的组`	否	配置SAML的组的ID
`链接（linkedin）`	否	LinkedIn链接
`位置`	否	用户的位置
`名称`	是的	姓名
`笔记`	否	此用户的管理员注释
`组织`	否	组织名称
`密码`	否	密码
`私人配置文件`	否	用户的配置文件是私有的-true或false。默认值由这设置。
`项目_限制`	否	用户可以创建的项目数
`代词`	否	用户的代词
`供应商`	否	外部提供程序名称
`公共电子邮件`	否	用户的公共电子邮件地址
`重置密码`	否	发送用户密码重置链接-true或false（默认）
`共享跑步者分钟限制`	否	只能由管理员设置。此用户的最大每月计算分钟数。可以是`无`（默认值；继承系统默认值），`0`（无限制），或`> 0`。仅限高级和旗舰版。
`跳过_确认`	否	跳过确认-true或false（默认）
`skype`	否	Skype ID
`主题_id`	否	用户的GitLab主题（有关更多信息，请参阅用户首选项文档更多信息）
`推特`	否	X（前推特）帐户
`不和谐`	否	不一致账户
`用户名`	是的	用户名
`查看difs_file_by_file`	否	指示用户每页只看到一个文件差异的标志
`网站url`	否	网站地址

用户修改

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个命名空间id响应中的字段是介绍GitLab 14.10中。
修改审计师用户的能力是介绍GitLab 15.3中。

修改现有用户。只有管理员才能更改用户的属性。

这个电子邮件字段是用户的主要电子邮件地址。您只能将此字段更改为该用户已添加的辅助电子邮件地址。要向同一用户添加更多电子邮件地址，请使用添加电子邮件功能.

PUT/users/：id

参数：

属性要求的描述

管理员 否用户是管理员。有效值为真的或假。默认为false。
审计师 否用户是审计师。有效值为真的或假。默认为false。介绍GitLab 15.3.（默认）仅限高级和旗舰版。
化身 否用户头像的图像文件
生物 否用户简介
可以创建组 否用户可以创建组-true或false
颜色方案id 否文件查看器的用户配色方案（有关详细信息，请参阅用户首选项文档更多信息）
提交电子邮件（_E） 否用户的提交电子邮件。设置为_私人使用私人提交电子邮件。介绍GitLab 15.5中。
电子邮件 否电子邮件
外部_uid 否外部UID
外部的 否将用户标记为外部-true或false（默认）
额外共享的runners_minutes_limit 否只能由管理员设置。此用户的额外计算分钟数。仅限高级和旗舰版。
用于saml的组 否配置SAML的组的ID
身份证件 是的用户ID
链接（linkedin） 否 LinkedIn链接
位置 否用户的位置
名称 否姓名
笔记 否此用户的管理说明
组织 否组织名称
密码 否密码
私人配置文件 否用户的配置文件是私有的-true或false。
项目_限制 否限制每个用户可以创建的项目
代词 否代词
供应商 否外部提供程序名称
公共电子邮件 否用户的公共电子邮件（必须已经验证）
共享跑步者分钟限制 否只能由管理员设置。此用户的最大每月计算分钟数。可以是无（默认值；继承系统默认值），0（无限制）或> 0。仅限高级和旗舰版。
跳过_重新确认 否跳过重新确认-true或false（默认）
skype 否 Skype ID
主题_id 否用户的GitLab主题（有关更多信息，请参阅用户首选项文档更多信息）
推特 否 X（前推特）帐户
不和谐 否不一致账户
用户名 否用户名
查看difs_file_by_file 否指示用户每页只看到一个文件差异的标志
网站url 否网站地址

属性	要求的	描述
`管理员`	否	用户是管理员。有效值为`真的`或`假`。默认为false。
`审计师`	否	用户是审计师。有效值为`真的`或`假`。默认为false。介绍GitLab 15.3.（默认）仅限高级和旗舰版。
`化身`	否	用户头像的图像文件
`生物`	否	用户简介
`可以创建组`	否	用户可以创建组-true或false
`颜色方案id`	否	文件查看器的用户配色方案（有关详细信息，请参阅用户首选项文档更多信息）
`提交电子邮件（_E）`	否	用户的提交电子邮件。设置为`_私人`使用私人提交电子邮件。介绍GitLab 15.5中。
`电子邮件`	否	电子邮件
`外部_uid`	否	外部UID
`外部的`	否	将用户标记为外部-true或false（默认）
`额外共享的runners_minutes_limit`	否	只能由管理员设置。此用户的额外计算分钟数。仅限高级和旗舰版。
`用于saml的组`	否	配置SAML的组的ID
`身份证件`	是的	用户ID
`链接（linkedin）`	否	LinkedIn链接
`位置`	否	用户的位置
`名称`	否	姓名
`笔记`	否	此用户的管理说明
`组织`	否	组织名称
`密码`	否	密码
`私人配置文件`	否	用户的配置文件是私有的-true或false。
`项目_限制`	否	限制每个用户可以创建的项目
`代词`	否	代词
`供应商`	否	外部提供程序名称
`公共电子邮件`	否	用户的公共电子邮件（必须已经验证）
`共享跑步者分钟限制`	否	只能由管理员设置。此用户的最大每月计算分钟数。可以是`无`（默认值；继承系统默认值），`0`（无限制）或`> 0`。仅限高级和旗舰版。
`跳过_重新确认`	否	跳过重新确认-true或false（默认）
`skype`	否	Skype ID
`主题_id`	否	用户的GitLab主题（有关更多信息，请参阅用户首选项文档更多信息）
`推特`	否	X（前推特）帐户
`不和谐`	否	不一致账户
`用户名`	否	用户名
`查看difs_file_by_file`	否	指示用户每页只看到一个文件差异的标志
`网站url`	否	网站地址

在更新密码时，用户必须在下次登录时更改密码。注意，目前此方法只返回404错误，即使在以下情况下409（冲突）更合适。例如，将电子邮件地址重命名为某个现有地址时。

从用户删除身份验证标识

级别：免费、高级、终极提供：自我管理，GitLab专用

使用与用户身份关联的提供程序名称删除用户的身份验证身份。仅适用于管理员。

DELETE/users/：id/identizes/：provider

参数：

属性类型要求的描述

身份证件 整数是的用户ID
供应商 一串是的外部提供程序名称

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID
`供应商`	一串	是的	外部提供程序名称

用户删除

级别：免费、高级、终极提供：自我管理，GitLab专用

删除用户。仅适用于管理员。这将返回一个204无内容状态代码，如果操作成功，404如果找不到资源或409如果用户不能被软删除。

删除/users/：id

参数：

属性类型要求的描述

身份证件 整数是的用户ID
硬删除（_D） 布尔值不如果是真的，捐款通常是移动到Ghost用户而是被删除，以及仅由该用户拥有的组。

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID
`硬删除（_D）`	布尔值	不	如果是真的，捐款通常是移动到Ghost用户而是被删除，以及仅由该用户拥有的组。

列出当前用户

获取当前用户。

对于非管理员用户

获取经过身份验证的用户。

获取/用户

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “电子邮件”: "john@example.com",
  “名称”: “约翰·史密斯”,
  “状态”: “活动”,
  “锁定”: 假,
  “化身url”: "http://localhost:3000/uploads/user/avatar/1/index.jpg",
  “网页url”: "http://localhost:3000/john_smith网址",
  “创建日期”: “2012-05-23T08:00:58Z”,
  “生物”: "",
  “位置”: 无效的,
  “公共电子邮件”: "john@example.com",
  “skype”: "",
  “linkedin”: "",
  “推特”: "",
  “不和谐”: "",
  “网站url”: "",
  “组织”: "",
  “作业_标题”: "",
  “代词”: “他/他”,
  “机器人”: 假,
  “工作信息”: 无效的,
  “关注者”: 0,
  “关注”: 0,
  “本地时间”: “下午3:38”,
  “最后签名日期”: “2012-06-01T11:41:01Z”,
  “确认日期”: “2012-05-23T09:05:22Z”,
  “主题_id”: 1,
  “last_activity_on”: "2012-05-23",
  “颜色方案id”: 2,
  “项目_限制”: 100,
  “当前签名_输入_”: “2012-06-02T06:36:55Z”,
  “身份”: [
    {“提供商”: “github”, “外部_uid”: "2435223452345"},
    {“提供商”: “比特桶”, “外部_uid”: “约翰·史密斯”},
    {“提供商”: “谷歌授权2”, “外部_uid”: "8776128412476123468721346"}
  ],
  “可以创建组”: 真的,
  “可以创建项目”: 真的,
  “双因素启用”: 真的,
  “外部”: 假,
  “私人配置文件”: 假,
  “提交电子邮件”: "admin@example.com",
}

上的用户GitLab Premium或Ultimate另请参见共享跑步者分钟限制,额外共享的runners_minutes_limit参数。

对于管理员

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个命名空间id响应中的字段是介绍GitLab 14.10中。
这个创建人（_B）响应中的字段是介绍GitLab 15.6中。
这个电子邮件已提供响应中的字段介绍在GitLab 16.7中。

获取/用户

参数：

属性类型要求的描述

苏多 整数不在其位置进行呼叫的用户的ID

属性	类型	要求的	描述
`苏多`	整数	不	在其位置进行呼叫的用户的ID

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “电子邮件”: "john@example.com",
  “名称”: “约翰·史密斯”,
  “状态”: “活动”,
  “锁定”: 假,
  “化身url”: "http://localhost:3000/uploads/user/avatar/1/index.jpg",
  “网页url”: "http://localhost:3000/john_smith网址",
  “创建日期”: “2012-05-23T08:00:58Z”,
  “is_admin”: 真的,
  “生物”: "",
  “位置”: 无效的,
  “公共电子邮件”: "john@example.com",
  “skype”: "",
  “linkedin”: "",
  “推特”: "",
  “不和谐”: "",
  “网站url”: "",
  “组织”: "",
  “作业_标题”: "",
  “最后签名日期”: “2012-06-01T11:41:01Z”,
  “确认日期”: “2012-05-23T09:05:22Z”,
  “主题_id”: 1,
  “last_activity_on”: "2012-05-23",
  “颜色方案id”: 2,
  “项目_限制”: 100,
  “当前签名_输入_”: “2012-06-02T06:36:55Z”,
  “身份”: [
    {“提供商”: “github”, “外部_uid”: "2435223452345"},
    {“提供商”: “比特桶”, “外部_uid”: “约翰·史密斯”},
    {“提供商”: “谷歌授权2”, “外部_uid”: "8776128412476123468721346"}
  ],
  “可以创建组”: 真的,
  “可以创建项目”: 真的,
  “双因素启用”: 真的,
  “外部”: 假,
  “私人配置文件”: 假,
  “提交电子邮件”: "john-codes@example.com",
  “当前签名_in_ip”: "196.165.1.102",
  “最后签名_输入”: "172.127.2.22",
  “命名空间id”: 1,
  “创建人（_B）”: 无效的,
  “电子邮件_设置_提供_ at”: 无效的,
  “备注”: 无效的
}

上的用户GitLab Premium或Ultimate也可以看到这些参数：

共享跑步者分钟限制
额外共享的runners_minutes_limit
是审核人（_A）
提供的_ by_group_id
使用许可证座位

用户状态

获取已验证用户的状态。

GET/用户/状态

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/user/status"

回答示例：

{
  “表情符号”:“咖啡”,
  “可用性”:“忙”,
  “消息”:“我渴望咖啡：咖啡：”,
  “message_html”: “我渴望咖啡<gl-emoji title=\"热饮\"数据名称=\"咖啡\"数据字典版本=\"4\">☕</gl-emoji>“,
  “清除状态”: 无效的
}

获取用户的状态

获取用户的状态。无需身份验证即可访问此端点。

GET/users/：id_or_username/状态

属性	类型	要求的	描述
`用户名id`	一串	是的	要获取状态的用户的ID或用户名

卷曲"https://gitlab.example.com/users/janedoe/status网站"

回答示例：

{
  “表情符号”:“咖啡”,
  “可用性”:“忙”,
  “消息”:“我渴望咖啡：咖啡：”,
  “message_html”: “我渴望咖啡<gl-emoji title=\"热饮\"数据名称=\"咖啡\"数据字典版本=\"4\">☕</gl-emoji>“,
  “清除状态”: 无效的
}

设置用户状态

设置当前用户的状态。

PUT/用户/状态PATCH/用户/状态

属性	类型	要求的	描述
`表情符号`	一串	不	要用作状态的表情符号的名称。如果省略`演讲厅`使用。表情符号名称可以是Gemojione指数.
`消息`	一串	不	要设置为状态的消息。它还可以包含表情符号代码。不能超过100个字符。
`清除状态之后`	一串	不	在给定时间间隔后自动清除状态，允许值为：`30分钟`,`3_小时`,`8_小时`,`1天`,`3天`,`7天`,`30天`

两者之间的差异PUT（输出）和补丁

使用时PUT（输出）任何未传递的参数都设置为无效的因此被清除。使用时补丁任何未传递的参数都将被忽略。显式传递无效的清除田地。

卷曲--请求PUT（输出）--收割台 “私人代币：<your_access_TOKEN>” --数据 “clear_status_after=1天” --数据 “emoji=咖啡” \
     --数据 “message=我渴望咖啡” "https://gitlab.example.com/api/v4/user/status"

回答示例

{
  “表情符号”:“咖啡”,
  “消息”:“我渴望咖啡”,
  “message_html”: “我渴望咖啡”,
  “清除状态”:“2021-02-15T10:49:01.311Z”
}

获取用户首选项

获取经过身份验证的用户的首选项列表。

GET/用户/首选项

回答示例：

{
  “id”: 1,
  “user_id”: 1,
  “view_diffs_file_by_file”: 真的,
  “show_whitespace_in_diffs”: 假,
  “pass_user_identities_to_ci_jwt”: 假
}

参数：

没有人

用户首选项修改

更新当前用户的首选项。

PUT/用户/首选项

{
  “id”: 1,
  “user_id”: 1,
  “view_diffs_file_by_file”: 真的,
  “show_whitespace_in_diffs”: 假,
  “pass_user_identities_to_ci_jwt”: 假
}

参数：

属性要求的描述

查看difs_file_by_file 是的指示用户每页只看到一个文件差异的标志。
显示_ hitespace_in_diffs 是的指示用户在diff中看到空白更改的标志。
pass_user_identities_to_ci_jwt 是的指示用户将其外部身份作为CI信息传递的标志。此属性包含的信息不足，无法识别或授权外部系统中的用户。该属性是GitLab的内部属性，不能传递给第三方服务。有关更多信息和示例，请参阅令牌有效负载.

属性	要求的	描述
`查看difs_file_by_file`	是的	指示用户每页只看到一个文件差异的标志。
`显示_ hitespace_in_diffs`	是的	指示用户在diff中看到空白更改的标志。
`pass_user_identities_to_ci_jwt`	是的	指示用户将其外部身份作为CI信息传递的标志。此属性包含的信息不足，无法识别或授权外部系统中的用户。该属性是GitLab的内部属性，不能传递给第三方服务。有关更多信息和示例，请参阅令牌有效负载.

用户关注

关注和取消关注用户

关注用户。

POST/users/：id/follow

展开对用户的关注。

POST/users/：id/unfollow

属性	类型	要求的	描述
`身份证件`	整数	是的	要关注的用户的ID

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/users/3/follow"

回答示例：

{
  “id”: 1,
  “用户名”: “约翰·史密斯”,
  “名称”: “约翰·史密斯”,
  “状态”: “活动”,
  “锁定”: 假,
  “化身url”: "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
  “网页url”: "http://localhost:3000/john_smith网址"
}

追随者和追随者

获取用户的关注者。

获取/用户/：id/关注者

获取正在关注的用户列表。

GET/users/：id/关注

属性	类型	要求的	描述
`身份证件`	整数	是的	要关注的用户的ID

卷曲--请求GET（获取）--收割台 “私人代币：<your_access_TOKEN>”  "https://gitlab.example.com/users/3/followers网站"

回答示例：

[
  {
    “id”: 2,
    “名称”: “伦尼·唐纳利”,
    “用户名”: “伊芙特·基尔巴克”,
    “状态”: “活动”,
    “锁定”: 假,
    “化身url”: "https://www.gravatar.com/avatar/7955171a55ac4997ed81e5976287890a？s=80&d=identicon",
    “网页url”: "http://127.0.0.1:3000/evte.kilback"
  },
  {
    “id”: 4,
    “名称”: “Serena Bradtke”,
    “用户名”: “卡米”,
    “状态”: “活动”,
    “锁定”: 假,
    “化身url”: "https://www.gravatar.com/avatar/a2daad869a7b60d3090b7b9bef4baf57？s=80&d=identicon",
    “网页url”: "网址：http://127.0.0.1:3000/cammy"
  }
]

用户计数

获取经过身份验证的用户的计数（与右上方菜单中的计数相同）。

属性类型描述

分配的问题 数打开并分配给当前用户的问题数。
分配的合并请求 数活动并分配给当前用户的合并请求数。
合并请求（_R） 数已弃用在GitLab 13.8中。等同于并替换为分配的合并请求.
审阅请求的合并请求 数请求当前用户审阅的合并请求数。
托多斯 数当前用户的待处理待办事项数。

属性	类型	描述
`分配的问题`	数	打开并分配给当前用户的问题数。
`分配的合并请求`	数	活动并分配给当前用户的合并请求数。
`合并请求（_R）`	数	已弃用在GitLab 13.8中。等同于并替换为`分配的合并请求`.
`审阅请求的合并请求`	数	请求当前用户审阅的合并请求数。
`托多斯`	数	当前用户的待处理待办事项数。

GET/user_counts（获取/用户计数）

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/user_counts网址"

回答示例：

{
  “合并请求”: 4,
  “分配的问题”: 15,
  “分配的_合并_请求”: 11,
  “审阅请求_合并请求”: 0,
  “待办事项”: 1
}

创建服务帐户用户

级别：高级，终极提供：自我管理，GitLab专用

历史

创建服务帐户用户的能力是介绍在GitLab 16.1中
指定用户名或名称的功能是介绍在GitLab 16.10中。

创建服务帐户用户。您可以指定帐户用户名和名称。如果不指定这些属性，则默认名称为服务帐户用户并自动生成用户名。仅适用于管理员。

POST/服务帐户

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/service_accounts"

支持的属性：

属性类型要求的描述

名称 一串不用户的名称
用户名 一串不用户的用户名

属性	类型	要求的	描述
`名称`	一串	不	用户的名称
`用户名`	一串	不	用户的用户名

回答示例：

{
  “id”: 57,
  “用户名”: “service_account_6018816a18e515214e0c34c2b33523fc”,
  “名称”: “服务帐户用户”
}

列出用户项目

请参阅用户项目列表.

用户的列表关联计数

获取指定用户计数的列表：

项目。
组。
问题。
合并请求。

管理员可以查询任何用户，但非管理员只能查询自己。

GET/users/：id/associations_count

参数：

属性类型要求的描述

身份证件 整数是的用户ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID

回答示例：

{
  “groups_count”: 2,
  “项目_计数”: 3,
  “issues_count”（问题_计数）: 8,
  “合并请求计数”: 5
}

列出SSH密钥

获取经过身份验证的用户的SSH密钥列表。

此函数接受分页参数第页和每个页面（_P）以限制密钥列表。

GET/用户/密钥

[
  {
    “id”: 1,
    “标题”: “公钥”,
    “密钥”: “ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpJNPZ7yKu+dnn1SJejgt4596k6YjzGgphH2TUxwKzxcKDKGezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=”,
    “创建日期”: “2014-08-01T14:47:39.080Z”
  },
  {
    “id”: 3,
    “标题”: “另一个公钥”,
    “密钥”: “ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpJNPZ7yKu+dnn1SJejgt4596k6YjzGgphH2TUxwKzxcKDKGezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=”,
    “创建日期”: “2014-08-01T14:47:39.080Z”
  }
]

参数：

没有人

列出用户的SSH密钥

获取指定用户的SSH密钥列表。

GET/users/：id_or_username/keys

属性	类型	要求的	描述
`用户名id`	一串	是的	要获取其SSH密钥的用户的ID或用户名。

单个SSH密钥

获取一把钥匙。

GET/user/keys/：key_id

参数：

属性类型要求的描述

密钥id 一串是的 SSH密钥的ID

属性	类型	要求的	描述
`密钥id`	一串	是的	SSH密钥的ID

{
  “id”: 1,
  “标题”: “公钥”,
  “密钥”: “ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpJNPZ7yKu+dnn1SJejgt4596k6YjzGgphH2TUxwKzxcKDKGezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=”,
  “创建日期”: “2014-08-01T14:47:39.080Z”
}

给定用户的单个SSH密钥

历史

介绍GitLab 14.9。

获取给定用户的单个密钥。

GET/users/：id/keys/：key_id

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID
密钥id 整数是的 SSH密钥ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID
`密钥id`	整数	是的	SSH密钥ID

{
  “id”: 1,
  “标题”: “公钥”,
  “密钥”: “ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpJNPZ7yKu+dnn1SJejgt4596k6YjzGgphH2TUxwKzxcKDKGezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=”,
  “创建日期”: “2014-08-01T14:47:39.080Z”
}

添加SSH密钥

历史

这个用法类型参数为介绍GitLab 15.7中。

创建由经过身份验证的用户拥有的新密钥。

POST（开机自检）/用户/按键

参数：

属性类型要求的描述

标题 一串是的新SSH密钥的标题
钥匙 一串是的新SSH密钥
过期日期（_A） 一串不 ISO 8601格式的SSH密钥的到期日期(YYYY-MM-DDTH:MM:SSZ年/月/日)
用法类型 一串不 SSH密钥的使用范围：授权,签署或授权和签名。默认值：授权和签名

属性	类型	要求的	描述
`标题`	一串	是的	新SSH密钥的标题
`钥匙`	一串	是的	新SSH密钥
`过期日期（_A）`	一串	不	ISO 8601格式的SSH密钥的到期日期(`YYYY-MM-DDTH:MM:SSZ年/月/日`)
`用法类型`	一串	不	SSH密钥的使用范围：`授权`,`签署`或`授权和签名`。默认值：`授权和签名`

{
  “标题”: “ABC”,
  “密钥”: “ssh-dss AAAAB3NzaC1kc3MAAACBAMLrhYgI3atfrSD6KDas1b/3n6R/HP+bLaHHX6oh+L1vg31mdUqK0Ac/NjZoQunavoyzdPYhFz9zzOezCrZKjuJDS3NRK9rspvjgM0xYR4d47oNZbdZbwkI4cTv/gcMlquRy0OvpfIvJtjtaJWMwTLtM5VhRusUlpH99UVeXAAAAFQCVyX+92hBEjInEKL0”v13c/egDCTQAAAIEAvFdWGq0ccOPbw4f/F8LpZqvWDydAcpXHV3thwb7WkFfppvm4SZte0zds1FJ+Hr8Xzzc5zMHe6J4Nlay/rP4ewmIW7iFKNBEYb/yWa+ceLrs+TfR672TaAgO6o7iSRofEq5YLdwgrwkMmIawa21FrZ2D9SPao/IwvENzk/xcHu7YAAACAQFXQH6HQnxOrw4dqf0NqeKy1tfIPxYYUZhPJfo9O0AmBW2S36pD2l14kS89fz6Y1gN/FwFnRncMzlLY/hX70FSc/3hKBSbH6ZnC6j8hwlgFKfizav21eS358Jz93leOakJGb8Xl Wvz1UJbwCsnR2VEY8Dz90uIk1l/UqHkA=loic@呼叫",
  “到期时间”: “2016年1月21日00:00:00.000Z”,
  “usage_type”: “身份验证”
}

返回状态为的已创建密钥201创建成功。如果发生错误400错误请求返回一条解释错误的消息：

{
  “消息”: {
    “指纹”: [
      “已被占用”
    ],
    “密钥”: [
      “已被占用”
    ]
  }
}

为用户添加SSH密钥

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个用法类型参数为介绍GitLab 15.7中。

创建指定用户拥有的新密钥。仅适用于管理员。

POST/users/：id/keys

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID
标题 一串是的新SSH密钥的标题
钥匙 一串是的新SSH密钥
过期日期（_A） 一串不 ISO 8601格式的SSH密钥的到期日期(YYYY-MM-DDTH:MM:SSZ年/月/日)
用法类型 一串不 SSH密钥的使用范围：授权,签署或授权和签名。默认值：授权和签名

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID
`标题`	一串	是的	新SSH密钥的标题
`钥匙`	一串	是的	新SSH密钥
`过期日期（_A）`	一串	不	ISO 8601格式的SSH密钥的到期日期(`YYYY-MM-DDTH:MM:SSZ年/月/日`)
`用法类型`	一串	不	SSH密钥的使用范围：`授权`,`签署`或`授权和签名`。默认值：`授权和签名`

{
  “标题”: “ABC”,
  “密钥”: “ssh-dss AAAAB3NzaC1kc3MAAACBAMLrhYgI3atfrSD6KDas1b/3n6R/HP+bLaHHX6oh+L1vg31mdUqK0Ac/NjZoQunavoyzdPYhFz9zzOezCrZKjuJDS3NRK9rspvjgM0xYR4d47oNZbdZbwkI4cTv/gcMlquRy0OvpfIvJtjtaJWMwTLtM5VhRusUlpH99UVeXAAAAFQCVyX+92hBEjInEKL0”v13c/egDCTQAAAIEAvFdWGq0ccOPbw4f/F8LpZqvWDydAcpXHV3thwb7WkFfppvm4SZte0zds1FJ+Hr8Xzzc5zMHe6J4Nlay/rP4ewmIW7iFKNBEYb/yWa+ceLrs+TfR672TaAgO6o7iSRofEq5YLdwgrwkMmIawa21FrZ2D9SPao/IwvENzk/xcHu7YAAACAQFXQH6HQnxOrw4dqf0NqeKy1tfIPxYYUZhPJfo9O0AmBW2S36pD2l14kS89fz6Y1gN/FwFnRncMzlLY/hX70FSc/3hKBSbH6ZnC6j8hwlgFKfizav21eS358Jz93leOakJGb8Xl Wvz1UJbwCsnR2VEY8Dz90uIk1l/UqHkA=loic@呼叫",
  “到期时间”: “2016年1月21日00:00:00.000Z”,
  “usage_type”: “身份验证”
}

返回状态为的已创建密钥201创建成功。如果发生错误400错误请求返回一条解释错误的消息：

{
  “消息”: {
    “指纹”: [
      “已被占用”
    ],
    “密钥”: [
      “已被占用”
    ]
  }
}

这还添加了审核事件。

删除当前用户的SSH密钥

删除已验证用户拥有的密钥。

这将返回一个204无内容操作成功时的状态代码或404如果找不到资源。

删除/user/keys/：key_id

参数：

属性类型要求的描述

密钥id 整数是的 SSH密钥ID

属性	类型	要求的	描述
`密钥id`	整数	是的	SSH密钥ID

删除给定用户的SSH密钥

级别：免费、高级、终极提供：自我管理，GitLab专用

删除指定用户拥有的密钥。仅适用于管理员。

DELETE/users/：id/keys/：key_id

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID
密钥id 整数是的 SSH密钥ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID
`密钥id`	整数	是的	SSH密钥ID

列出所有GPG密钥

获取经过身份验证的用户的GPG密钥列表。

获取/用户/gpg_keys

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/user/gpg_keys网站"

回答示例：

[
    {
        “id”: 1,
        “密钥”: “-----开始PGP公共密钥块-----\\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司\\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型\\r\n村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3TARzCvnNGtzEFRtpIEtZ0cuctseIF1id5\\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4\\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司\\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=\\r\n=XQoy\\r\n-----结束PGP公钥块-----“,
        “创建日期”: “2017-09-05T09:17:46.264Z”
    }
]

获取特定的GPG密钥

获取经过身份验证的用户的特定GPG密钥。

GET/user/gpg_keys/：key_id

参数：

属性类型要求的描述

密钥id 整数是的 GPG密钥的ID

属性	类型	要求的	描述
`密钥id`	整数	是的	GPG密钥的ID

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/user/gpg_keys/1"

回答示例：

  {
      “id”: 1,
      “密钥”: “-----开始PGP公共密钥块-----\\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司\\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型\\r\n村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3TARzCvnNGtzEFRtpIEtZ0cuctseIF1id5\\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4\\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司\\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=\\r\n=XQoy\\r\n-----结束PGP公钥块-----“,
      “创建日期”: “2017-09-05T09:17:46.264Z”
  }

添加GPG密钥

创建由已验证用户拥有的新GPG密钥。

POST/用户/gpg_keys

参数：

属性类型要求的描述

钥匙 一串是的新GPG密钥

属性	类型	要求的	描述
`钥匙`	一串	是的	新GPG密钥

出口钥匙="$(全球定位系统--装甲 --出口<您的gpg_key_id>)"卷曲--数据编码 “key=-----开始PGP公共密钥块----->xsBNBFVjnlIBCAcibzXOLCiZiL2oyzYUaTOCkYnSUhymmg3pdbfKtd4mpBa58xKBj>t1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O>CfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司>qKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO>VaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型>村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp>IDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV>CAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/>oO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5>crfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4>bjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司>iE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp>o4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=>=XQoy>-----结束PGP公共键块-----“ \
     --收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/user/gpg_keys网站"

回答示例：

[
    {
        “id”: 1,
        “密钥”: “-----开始PGP公共密钥块-----\n个xsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\n个t1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\n个CfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司\n个qKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\n个VaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型\n个村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\n个IDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\n个CAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\n个oO2cDWCw50jZ9D91PXOOyMPvBWV2IE3TARzCvnNGtzEFRtpIEtZ0cuctseIF1id5\n个crfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4\n个bjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司\n个iE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\n个o4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=\n个=XQoy\n个-----结束PGP公钥块-----“,
        “创建日期”: “2017-09-05T09:17:46.264Z”
    }
]

删除GPG密钥

删除已验证用户拥有的GPG密钥。

删除/user/gpg_keys/：key_id

参数：

属性类型要求的描述

密钥id 整数是的 GPG密钥的ID

属性	类型	要求的	描述
`密钥id`	整数	是的	GPG密钥的ID

卷曲--请求删除--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/user/gpg_keys/1"

退换商品204无内容成功或404未找到如果找不到密钥。

列出给定用户的所有GPG密钥

获取指定用户的GPG密钥列表。无需身份验证即可访问此端点。

GET/users/：id/gpg_keys

参数：

属性类型要求的描述

身份证件 整数是的用户ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/2/gpg_keys（https://gitlab.example.com/api/v4/users/2/gpg_keys）"

回答示例：

[
    {
        “id”: 1,
        “密钥”: “-----开始PGP公共密钥块-----\\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司\\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型\\r\n村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3TARzCvnNGtzEFRtpIEtZ0cuctseIF1id5\\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4\\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司\\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=\\r\n=XQoy\\r\n-----结束PGP公钥块-----“,
        “创建日期”: “2017-09-05T09:17:46.264Z”
    }
]

获取给定用户的特定GPG密钥

获取给定用户的特定GPG密钥。无需管理员身份验证即可访问此端点。

GET/users/：id/gpg_keys/：key_id

参数：

属性类型要求的描述

身份证件 整数是的用户ID
密钥id 整数是的 GPG密钥的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID
`密钥id`	整数	是的	GPG密钥的ID

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/2/gpg_keys/1"

回答示例：

  {
      “id”: 1,
      “密钥”: “-----开始PGP公共密钥块-----\\r\n\r\nxsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\\r\nt1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\\r\nCfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司\\r\nqKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\\r\nVaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型\\r\n村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\\r\nIDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\\r\nCAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\\r\noO2cDWCw50jZ9D91PXOOyMPvBWV2IE3TARzCvnNGtzEFRtpIEtZ0cuctseIF1id5\\r\ncrfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4\\r\nbjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司\\r\niE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\\r\no4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=\\r\n=XQoy\\r\n-----结束PGP公钥块-----“,
      “创建日期”: “2017-09-05T09:17:46.264Z”
  }

为给定用户添加GPG密钥

级别：免费、高级、终极提供：自我管理，GitLab专用

创建指定用户拥有的新GPG密钥。仅适用于管理员。

POST/users/：id/gpg_keys

参数：

属性类型要求的描述

身份证件 整数是的用户ID
密钥id 整数是的 GPG密钥的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID
`密钥id`	整数	是的	GPG密钥的ID

卷曲--数据编码 “key=-----开始PGP公共密钥块----->xsBNBFVjnlIBCAcibzXOLCiZiL2oyzYUaTOCkYnSUhymmg3pdbfKtd4mpBa58xKBj>t1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O>CfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司>qKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO>VaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型>村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp>IDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV>CAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/>oO2cDWCw50jZ9D91PXOOyMPvBWV2IE3tARzCvnNGtzEFRtpIEtZ0cuctxeIF1id5>crfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4>bjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司>iE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp>o4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=>=XQoy>-----结束PGP公共键块-----“ \
     --收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/2/gpg_keys（https://gitlab.example.com/api/v4/users/2/gpg_keys）"

回答示例：

[
    {
        “id”: 1,
        “密钥”: “-----开始PGP公共密钥块-----\n个xsBNBFVjnlIBCACibzXOLCiZiL2oyzYUaTOCkYnSUhymg3pdbfKtd4mpBa58xKBj\n个t1pTHVpw3Sk03wmzhM/Ndlt1AV2YhLv++83WKr+gAHFYFiCV/tnY8bx3HqvVoy8O\n个CfxWhw4QZK7+oYzVmJj8ZJm3ZjOC4pzuegNWlNLCUdZDx9OKlHVXLCX1iUbjdYWa公司\n个qKV6tdV8hZolkbyjedQgrpvoWyeSHHpwHF7yk4gNJWMMI5rpcssL7i6mMXb/sDzO\n个VaAtU5wiVducsOa01InRFf7QSTxoAm6Xy0PGv/k48M6xCALa9nY+BzlOv47jUT57型\n个村庄4Szy9dKD0v9S0mQ+IHB+gNukWrnwtXx5ABEBAAHNFm5hbWUgKGNvbW1lbnQp\n个IDxlbUBpbD7CwHUEEwECACkFAlVjnlIJEINgJNgv009/AhsDAhkBBgsJCAcDAgYV\n个CAIJCgsEFgIDAQAAxqMIAFBHuBA8P1v8DtHonIK8Lx2qU23t8Mh68HBIkSjk2H7/\n个oO2cDWCw50jZ9D91PXOOyMPvBWV2IE3TARzCvnNGtzEFRtpIEtZ0cuctseIF1id5\n个crfzdMDsmZyRHAOoZ9VtuD6mzj0ybQWMACb7eIHjZDCee3Sl3TVrLy06YRdq2I4\n个bjMOPePtK5xnIpHGpAXkB3IONxyITpSLKsA4hCeP7gVvm7r7TuQg1ygiUBlWbBYn公司\n个iE5ROzqZjG1s7dQNZK/riiU2umGqGuwAb2IPvNiyuGR3cIgRE4llXH/rLuUlspAp\n个o4nlxaz65VucmNbN1aMbDXLJVSqR1DuE00vEsL1AItI版本=\n个=XQoy\n个-----结束PGP公钥块-----“,
        “创建日期”: “2017-09-05T09:17:46.264Z”
    }
]

删除给定用户的GPG密钥

级别：免费、高级、终极提供：自我管理，GitLab专用

删除指定用户拥有的GPG密钥。仅适用于管理员。

删除/users/：id/gpg_keys/：key_id

参数：

属性类型要求的描述

身份证件 整数是的用户ID
密钥id 整数是的 GPG密钥的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID
`密钥id`	整数	是的	GPG密钥的ID

卷曲--请求删除--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/2/gpg_keys/1"

列出电子邮件

获取经过身份验证的用户的电子邮件列表。

此终结点不返回主电子邮件地址，但第25077期建议更改此行为。

GET/用户/电子邮件

[
  {
    “id”: 1,
    “电子邮件”: "电子邮件@example.com",
    “确认日期” : “2021-03-26T19:07:56.248Z”
  },
  {
    “id”: 3,
    “电子邮件”: "电子邮件2@example.com",
    “确认日期” : 无效的
  }
]

参数：

没有人

列出用户的电子邮件

级别：免费、高级、终极提供：自我管理，GitLab专用

获取指定用户的电子邮件列表。仅适用于管理员

此终结点不返回主电子邮件地址，但第25077期建议更改此行为。

GET/users/：id/电子邮件

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID

单个电子邮件

获取一封电子邮件。

GET/user/emails/：电子邮件id

参数：

属性类型要求的描述

电子邮件id 整数是的电子邮件ID

属性	类型	要求的	描述
`电子邮件id`	整数	是的	电子邮件ID

{
  “id”: 1,
  “电子邮件”: "电子邮件@example.com",
  “确认日期” : “2021-03-26T19:07:56.248Z”
}

添加电子邮件

创建由经过身份验证的用户拥有的新电子邮件。

POST/用户/电子邮件

参数：

属性类型要求的描述

电子邮件 一串是的电子邮件地址

属性	类型	要求的	描述
`电子邮件`	一串	是的	电子邮件地址

{
  “id”: 4,
  “电子邮件”: "电子邮件@example.com",
  “确认日期” : “2021-03-26T19:07:56.248Z”
}

返回已创建的带有状态的电子邮件201创建成功。如果发生错误400错误请求返回一条解释错误的消息：

{
  “消息”: {
    “电子邮件”: [
      “已被占用”
    ]
  }
}

为用户添加电子邮件

级别：免费、高级、终极提供：自我管理，GitLab专用

创建指定用户拥有的新电子邮件。仅适用于管理员

POST/users/：id/电子邮件

参数：

属性类型要求的描述

身份证件 一串是的指定用户的ID
电子邮件 一串是的电子邮件地址
跳过_确认 布尔值不跳过确认并假设电子邮件已验证-true或false（默认）

属性	类型	要求的	描述
`身份证件`	一串	是的	指定用户的ID
`电子邮件`	一串	是的	电子邮件地址
`跳过_确认`	布尔值	不	跳过确认并假设电子邮件已验证-true或false（默认）

删除当前用户的电子邮件

删除已验证用户拥有的指定电子邮件地址。无法用于删除主电子邮件地址。

如果删除的电子邮件地址用于任何用户电子邮件，则这些用户电子邮件将发送到主电子邮件地址。

因为已知问题，组通知仍发送到删除的电子邮件地址。

删除/user/emails/：email_id

参数：

属性类型要求的描述

电子邮件id 整数是的电子邮件ID

属性	类型	要求的	描述
`电子邮件id`	整数	是的	电子邮件ID

退货：

204无内容如果手术成功。
404如果找不到资源。

删除给定用户的电子邮件

级别：免费、高级、终极提供：自我管理，GitLab专用

前提条件：

您必须是自我管理GitLab实例的管理员。

删除指定用户拥有的电子邮件地址。这无法删除主电子邮件地址。

删除/users/：id/emails/：email_id

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID
电子邮件id 整数是的电子邮件ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID
`电子邮件id`	整数	是的	电子邮件ID

阻止用户

级别：免费、高级、终极提供：自我管理，GitLab专用

阻止指定的用户。仅适用于管理员。

POST/用户/：id/块

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID

退货：

201正常成功。
404找不到用户如果找不到用户。
403禁止尝试阻止时：
- 通过LDAP阻止的用户。
- 内部用户。

取消阻止用户

级别：免费、高级、终极提供：自我管理，GitLab专用

取消阻止指定的用户。仅适用于管理员。

POST/users/：id/取消阻止

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID

退换商品201正常成功，404找不到用户是找不到用户或403禁止尝试解除阻止LDAP同步阻止的用户时。

停用用户

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 12.4。

停用指定的用户。仅适用于管理员。

POST/users/：id/停用

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID

退货：

201正常成功。
404找不到用户如果找不到用户。
403禁止尝试停用以下用户时：
- 被管理员或LDAP同步阻止。
- 不是休眠的.
- 内部。

激活用户

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 12.4。

激活指定的用户。仅适用于管理员。

POST/users/：id/activate

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID

退货：

201正常成功。
404找不到用户如果找不到用户。
403禁止如果用户因管理员或LDAP同步阻止而无法激活。

禁止用户

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 14.3。

禁止指定的用户。仅适用于管理员。

POST/users/：id/ban

参数：

身份证件（必需）-指定用户的ID

退货：

201正常成功。
404找不到用户如果找不到用户。
403禁止试图禁止非活动用户时。

取消绑定用户

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 14.3。

取消绑定指定的用户。仅适用于管理员。

POST/用户/：id/unban

参数：

身份证件（必需）-指定用户的ID

退货：

201正常成功。
404找不到用户如果找不到用户。
403禁止尝试取消屏蔽未被禁止的用户时。

获取用户贡献事件

请参阅事件API文档

获取用户的所有模拟令牌

级别：免费、高级、终极提供：自我管理，GitLab专用

需要管理员访问权限。

它检索用户的每个模拟令牌。使用分页参数第页和每个页面（_P）以限制模拟令牌的列表。

GET/users/：user_id/模拟令牌

参数：

属性类型要求的描述

用户id 整数是的用户ID
状态 一串不基于状态筛选标记(全部的,积极的,非活动的)

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/42/模拟令牌"

回答示例：

[
   {
      “活动” : 真的,
      “user_id” : 2,
      “范围” : [
         “api”
      ],
      “已撤销” : 假,
      “名称” : “我的代币”,
      “id” : 2,
      “创建日期” : “2017-03-17T17:18:09.283Z”,
      “模拟” : 真的,
      “到期时间” : "2017-04-04",
      “上次使用日期”: “2017-03-24T09:44:21.722Z”
   },
   {
      “活动” : 假,
      “user_id” : 2,
      “范围” : [
         “读取用户”
      ],
      “已撤销” : 真的,
      “名称” : “mytoken2”,
      “创建日期” : “2017-03-17T17:19:28.697Z”,
      “id” : 3,
      “模拟” : 真的,
      “到期时间” : "2017-04-14",
      “上次使用日期”: “2017-03-24T09:44:21.722Z”
   }
]

批准用户

级别：免费、高级、终极提供：自我管理，GitLab专用

批准指定的用户。仅适用于管理员。

POST/users/：id/approve

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/42/approve"

退货：

201创建成功。
404找不到用户如果找不到用户。
403禁止如果用户因管理员或LDAP同步阻止而无法获得批准。
409冲突如果用户已被停用。

回答示例：

{ “消息”: “成功” }

{ “消息”: “404找不到用户” }

{ “消息”: “您试图批准的用户没有等待批准” }

拒绝用户

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 14.3。

拒绝指定的等待批准。仅适用于管理员。

POST/users/：id/reject

参数：

身份证件（必需）-指定用户的ID

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/42/reject（拒绝）"

退货：

200正常成功。
403禁止如果未作为管理员进行身份验证。
404找不到用户如果找不到用户。
409冲突如果用户没有等待批准。

回答示例：

{ “消息”: “成功” }

{ “消息”: “404找不到用户” }

{ “消息”: “用户没有挂起的请求” }

获取用户的模拟令牌

级别：免费、高级、终极提供：自我管理，GitLab专用

需要管理员权限。

它显示用户的模拟令牌。

GET/users/：user_id/模拟令牌/：模拟令牌_id

参数：

属性类型要求的描述

用户id 整数是的用户ID
模拟令牌id 整数是的模拟令牌的ID

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/42/模拟令牌/2"

回答示例：

{
   “活动” : 真的,
   “user_id” : 2,
   “范围” : [
      “api”
   ],
   “已撤销” : 假,
   “名称” : “我的代币”,
   “id” : 2,
   “创建日期” : “2017-03-17T17:18:09.283Z”,
   “模拟” : 真的,
   “到期时间” : "2017-04-04"
}

创建模拟令牌

级别：免费、高级、终极提供：自我管理，GitLab专用

需要管理员访问权限。标记值返回一次。确保保存它，因为您无法访问又是这样。

它创建一个新的模拟令牌。只有管理员可以执行此操作。您只能创建模拟令牌来模拟用户并执行API调用和Git读写。用户在其个人资料中看不到这些标记设置页面。

POST/users/：user_id/模拟令牌

属性	类型	要求的	描述
`用户id`	整数	是的	用户ID
`名称`	一串	是的	模拟令牌的名称
`过期日期（_A）`	日期	是的	ISO格式的模拟令牌的到期日期(`年-月-日`)
`范围`	阵列	是的	模拟令牌的作用域数组(`应用程序编程接口`,`读取用户（_U）`)

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” --数据 “name=mytoken” --数据 “expires_at=2017-04-04” \
     --数据 “scopes[]=api” "https://gitlab.example.com/api/v4/users/42/模拟令牌"

回答示例：

{
   “id” : 2,
   “已撤销” : 假,
   “user_id” : 2,
   “范围” : [
      “api”
   ],
   “代币” : “EsMo-vhKfXGwX9RKrwiy”,
   “活动” : 真的,
   “模拟” : 真的,
   “名称” : “我的代币”,
   “创建日期” : “2017-03-17T17:18:09.283Z”,
   “到期时间” : "2017-04-04"
}

吊销模拟令牌

级别：免费、高级、终极提供：自我管理，GitLab专用

需要管理员访问权限。

它将撤销模拟令牌。

DELETE/users/：user_id/模拟令牌/：模拟令牌_id

参数：

属性类型要求的描述

用户id 整数是的用户ID
模拟令牌id 整数是的模拟令牌的ID

卷曲--请求删除--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/42/模拟令牌/1"

创建个人访问令牌

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

这个过期日期（_A）属性默认值为介绍在GitLab 16.0中。

使用此API创建新的个人访问令牌。令牌值返回一次，请确保保存它，因为您无法再次访问它。此API只能由使用GitLab管理员。

POST/users/：user_id/personal_access_tokens

属性	类型	要求的	描述
`用户id`	整数	是的	用户ID
`名称`	一串	是的	个人访问令牌的名称
`过期日期（_A）`	日期	不	ISO格式的访问令牌的到期日期(`年-月-日`). 如果未设置日期，则过期时间设置为访问令牌的最大允许生存期.
`范围`	阵列	是的	个人访问令牌的作用域数组。请参见个人访问令牌作用域以获取可能的值。

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” --数据 “name=mytoken” --数据 “expires_at=2017-04-04” \
     --数据 “scopes[]=api” "https://gitlab.example.com/api/v4/users/42/personal_access_tokens"

回答示例：

{
    “id”: 3,
    “名称”: “我的代币”,
    “已撤销”: 假,
    “创建日期”: “2020-10-14T11:58:53.526Z”,
    “范围”: [
        “api”
    ],
    “user_id”: 42,
    “活动”: 真的,
    “到期时间”: "2020-12-31",
    “代币”: “ggbfKkC4n-Lujy8jwCR2”
}

为当前经过身份验证的用户创建具有有限范围的个人访问令牌

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍在GitLab 16.5中。

使用此API为当前经过身份验证的用户创建新的个人访问令牌。出于安全目的，令牌：

仅限于k8s_代理范围.此范围授予使用Kubernetes代理执行KubernetesAPI调用的权限。
默认情况下，在创建它的当天结束时过期。

令牌值只返回一次，因此请确保在无法访问时保存令牌又是这样。

POST/用户/个人访问令牌

属性	类型	要求的	描述
`名称`	一串	是的	个人访问令牌的名称
`范围`	阵列	是的	个人访问令牌的作用域数组。可能的值为`k8s_代理`
`过期日期（_A）`	阵列	不	ISO格式的访问令牌的到期日期(`年-月-日`). 如果未设置日期，则截止日期为当天结束时。有效期取决于访问令牌的最大允许生存期.

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” --数据 “name=mytoken” --数据 “scopes[]=k8s_proxy” "https://gitlab.example.com/api/v4/user/personal_access_tokens网站"

回答示例：

{
    “id”: 3,
    “名称”: “我的代币”,
    “已撤销”: 假,
    “创建日期”: “2020-10-14T11:58:53.526Z”,
    “范围”: [
        “k8s_proxy”
    ],
    “user_id”: 42,
    “活动”: 真的,
    “到期时间”: "2020-10-15",
    “代币”: “<your_new_access_token>”
}

获取用户活动

级别：免费、高级、终极提供：自我管理，GitLab专用

预审：

您必须是管理员才能查看具有私人配置文件的用户的活动。

获取具有公共配置文件的用户的上次活动日期，从最旧到最新排序。

更新用户事件时间戳的活动(上次活动日期和当前签名)是：

Git HTTP/SSH活动（例如克隆、推送）
用户登录GitLab
用户访问与仪表板、项目、问题和合并请求相关的页面(介绍GitLab 11.8）
使用API的用户
使用GraphQL API的用户

默认情况下，它显示过去6个月内具有公共配置文件的用户的活动，但这可以是通过使用从参数。

获取/用户/活动

参数：

属性类型要求的描述

从 一串不格式为的日期字符串年-月-日例如，2016-03-11。默认为6个月前。

属性	类型	要求的	描述
`从`	一串	不	格式为的日期字符串`年-月-日`例如，`2016-03-11`。默认为6个月前。

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/user/activities网站"

回答示例：

[
  {
    “用户名”: “用户1”,
    “last_activity_on”: "2015-12-14",
    “last_activity_at”: "2015-12-14"
  },
  {
    “用户名”: “用户2”,
    “last_activity_on”: "2015-12-15",
    “last_activity_at”: "2015-12-15"
  },
  {
    “用户名”: “用户3”,
    “last_activity_on”: "2015-12-16",
    “last_activity_at”: "2015-12-16"
  }
]

上次活动时间已弃用。使用上次活动日期而不是。

用户成员身份

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 12.8。

预审：

你必须是管理员。

列出用户所属的所有项目和组。它返回源id,源名称,源类型（_T）、和访问级别会员资格。源可以是类型命名空间（代表一个团体）或项目。响应仅代表直接成员身份。继承的成员身份（例如在子组中）不包括在内。访问级别由整数值表示。有关更多详细信息，请阅读访问级别值.

GET/users/：id/成员身份

参数：

属性类型要求的描述

身份证件 整数是的指定用户的ID
类型 一串不按类型筛选成员身份。可以是任意一种项目或命名空间

属性	类型	要求的	描述
`身份证件`	整数	是的	指定用户的ID
`类型`	一串	不	按类型筛选成员身份。可以是任意一种`项目`或`命名空间`

退货：

200正常成功。
404找不到用户如果找不到用户。
403禁止管理员没有要求时。
400错误请求不支持请求的类型。

卷曲--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/：user_id/memberships"

回答示例：

[
  {
    “源id”: 1,
    “源名称”: “项目一”,
    “源类型”: “项目”,
    “访问级别”: "20"
  },
  {
    “源id”: 3,
    “源名称”: “第三组”,
    “源类型”: “命名空间”,
    “访问级别”: "20"
  }
]

禁用双因素身份验证

级别：免费、高级、终极提供：自我管理，GitLab专用

历史

介绍GitLab 15.2。

预审：

你必须是管理员。

为指定用户禁用双因素身份验证（2FA）。

管理员不能为自己的用户帐户或其他使用API的管理员禁用2FA。相反，他们可以禁用管理员的2FA使用Rails控制台.

PATCH/users/：id/disable_two_factor

参数：

属性类型要求的描述

身份证件 整数是的用户ID

属性	类型	要求的	描述
`身份证件`	整数	是的	用户ID

卷曲--请求补丁--收割台 “私人代币：<your_access_TOKEN>” "https://gitlab.example.com/api/v4/users/1/disable_two_factor"

退货：

204无内容成功。
400错误请求如果没有为指定用户启用双因素身份验证。
403禁止如果未作为管理员进行身份验证。
404找不到用户如果找不到用户。

创建链接到用户的跑步者

级别：免费、高级、终极提供：GitLab.com，自我管理，GitLab专用

创建链接到当前用户的跑步者。

前提条件：

您必须是管理员或具有目标命名空间或项目的所有者角色。
对于实例类型，您必须是GitLab实例的管理员。
对于组_类型或项目_类型对于所有者角色，管理员不能启用限制跑步者注册.
带有创建跑步者范围。

确保复制或保存代币在响应中，无法再次检索该值。

POST/用户/跑步者

属性	类型	要求的	描述
`跑步者类型`	一串	是的	指定流道的范围；`实例类型`,`组_类型`，或`项目_类型`.
`组id`	整数	不	创建跑步者所在的组的ID。如果是，则为必填项`跑步者类型`是`组_类型`.
`项目id`	整数	不	创建跑步者的项目的ID。如果是，则为必填项`跑步者类型`是`项目_类型`.
`描述`	一串	不	流道的描述。
`暂停`	布尔值	不	指定运行器是否应忽略新作业。
`锁定`	布尔值	不	指定是否应为当前项目锁定流道。
`未标记的运行（_U）`	布尔值	不	指定运行器是否应处理未标记的作业。
`标记列表`	字符串数组	不	跑步者标签列表。
`访问级别`	一串	不	转轮的访问级别；`未受保护`或`ref_受保护`.
`最大超时时间`	整数	不	限制运行者可以运行作业的时间量（以秒为单位）的最大超时。
`维护_注释`	一串	不	转轮的免费维护说明（1024个字符）。

卷曲--请求岗位--收割台 “私人代币：<your_access_TOKEN>” --数据 “runner_type=实例类型” \
     "https://gitlab.example.com/api/v4/user/lunners"

回答示例：

{
    “id”: 9171,
    “代币”: “glrt-kyahzxLaj4Dc1jQf4xjX”,
    “token_expires_at”: 无效的
}