2.20. 超级用户


超级用户 API.

2.20.1. listAllUsers

返回系统中所有用户的列表。

GET /api/v1/superuser/users/

Authorizations: oauth2_implicit(super:user)

查询参数
类型Name描述模式

query

禁用
可选

如果为 false,则只返回启用的用户。

布尔值

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.2. createInstallUser

创建新用户。

POST /api/v1/superuser/users/

Authorizations: oauth2_implicit(super:user)

请求正文模式(application/json)

创建用户的数据

名称描述模式

username
optional

创建用户的用户名

字符串

email
可选

创建用户的电子邮件地址

字符串

响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.3. listAllLogs

列出当前系统的使用日志。

GET /api/v1/superuser/logs

Authorizations: oauth2_implicit(super:user)

查询参数
类型Name描述模式

query

next_page
optional

下一页面页面的页面令牌

字符串

query

Page
可选

日志的页面号

整数

query

ENDTIME
可选

获取日志的最新时间(%m/%d/%Y %Z)

字符串

query

starttime
optional

从中获取日志的早期时间(%m/%d/%Y %Z)

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.4. listServiceKeys

GET /api/v1/superuser/keys

Authorizations: oauth2_implicit(super:user)

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.5. createServiceKey

POST /api/v1/superuser/keys

Authorizations: oauth2_implicit(super:user)

请求正文模式(application/json)

创建服务密钥的描述

名称描述模式

service
可选

使用这个密钥进行身份验证的服务

字符串

name
可选

服务密钥的友好名称

字符串

metadata
optional

此键元数据的键/值对

对象

notes
可选

如果指定,则密钥的额外备注

字符串

过期
可选

作为 unix 时间戳的过期日期

 
响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.6. deleteUserQuotaSuperUser

DELETE /api/v1/superuser/organization/{namespace}/quota/{quota_id}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

quota_id
required

 

字符串

path

namespace
必需

 

字符串

响应
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.7. changeUserQuotaSuperUser

PUT /api/v1/superuser/organization/{namespace}/quota/{quota_id}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

quota_id
required

 

字符串

path

namespace
必需

 

字符串

请求正文模式(application/json)

新机构配额的描述

名称描述模式

limit_bytes
optional

允许机构允许的字节数

整数

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.8. createUserQuotaSuperUser

POST /api/v1/superuser/organization/{namespace}/quota

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

namespace
必需

 

字符串

请求正文模式(application/json)

新机构配额的描述

名称描述模式

limit_bytes
optional

允许机构允许的字节数

整数

响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.9. deleteOrganizationQuotaSuperUser

DELETE /api/v1/superuser/users/{namespace}/quota/{quota_id}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

quota_id
required

 

字符串

path

namespace
必需

 

字符串

响应
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.10. changeOrganizationQuotaSuperUser

PUT /api/v1/superuser/users/{namespace}/quota/{quota_id}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

quota_id
required

 

字符串

path

namespace
必需

 

字符串

请求正文模式(application/json)

新机构配额的描述

名称描述模式

limit_bytes
optional

允许机构允许的字节数

整数

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.11. createOrganizationQuotaSuperUser

POST /api/v1/superuser/users/{namespace}/quota

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

namespace
必需

 

字符串

请求正文模式(application/json)

新机构配额的描述

名称描述模式

limit_bytes
optional

允许机构允许的字节数

整数

响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.12. deleteOrganization

删除指定的机构。

DELETE /api/v1/superuser/organizations/{name}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

name
必需

管理有 organizaton 的名称

字符串

响应
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.13. changeOrganization

更新指定用户的信息。

PUT /api/v1/superuser/organizations/{name}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

name
必需

管理有 organizaton 的名称

字符串

请求正文模式(application/json)

现有机构的更新描述

名称描述模式

email
可选

机构联系电子邮件

字符串

invoice_email
optional

无论组织是否需要接收发票的电子邮件

布尔值

invoice_email_address
optional

接收发票的电子邮件地址

 

tag_expiration_s
optional

标签过期的秒数

整数

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.14. approveServiceKey

POST /api/v1/superuser/approvedkeys/{kid}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

kid
required

服务密钥的唯一标识符

字符串

请求正文模式(application/json)

批准服务密钥的信息

名称描述模式

notes
可选

可选批准备注

字符串

响应
HTTP 代码描述模式

201

成功创建

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.15. getServiceKey

GET /api/v1/superuser/keys/{kid}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

kid
required

服务密钥的唯一标识符

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.16. deleteServiceKey

DELETE /api/v1/superuser/keys/{kid}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

kid
required

服务密钥的唯一标识符

字符串

响应
HTTP 代码描述模式

204

已删除

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.17. updateServiceKey

PUT /api/v1/superuser/keys/{kid}

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

kid
required

服务密钥的唯一标识符

字符串

请求正文模式(application/json)

服务密钥更新的描述

名称描述模式

name
可选

服务密钥的友好名称

字符串

metadata
optional

此键元数据的键/值对

对象

过期
可选

作为 unix 时间戳的过期日期

 
响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.18. getRepoBuildStatusSuperUser

返回构建 uuids 指定的构建的状态。

GET /api/v1/superuser/{build_uuid}/status

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

build_uuid
required

构建的 UUID

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.19. getRepoBuildSuperUser

返回有关构建的信息。

GET /api/v1/superuser/{build_uuid}/build

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

build_uuid
required

构建的 UUID

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

2.20.20. getRepoBuildLogsSuperUser

返回构建 uuid 指定构建的构建日志。

GET /api/v1/superuser/{build_uuid}/logs

Authorizations: oauth2_implicit(super:user)

路径参数
类型Name描述模式

path

build_uuid
required

构建的 UUID

字符串

响应
HTTP 代码描述模式

200

成功调用

 

400

错误请求

ApiError

401

必需的会话

ApiError

403

未授权访问

ApiError

404

未找到

ApiError

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.