- 此版本的文档已存档，不再提供支持。 查看最新文档，学习；了解如何升级Atlas CLI版本。
实验：更新您为指定项目指定的组织API密钥的角色。
您必须为项目指定至少一个有效的角色。如果您未在此请求中包含任何角色，而这些角色之前已在您为项目指定的组织API密钥中设立，应用程序会删除这些角色。此命令正在调用 OperationID 为“updateApiKeyRoles”的端点。有关标志、文件格式和示例的更多信息，请参阅：https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Programmatic-API-Keys/operation/updateApiKeyRoles
语法
atlas api programmaticApiKeys updateApiKeyRoles [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--apiUserId | 字符串 | true | 唯一的 24-十六进制数字字符串，用于标识要从一个项目取消分配的组织API密钥 |
--envelope | false | 标志，指示应用程序是否将响应包装在信封JSON对象中 | |
--file | 字符串 | false | 包含API请求内容的文件的路径 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串 |
-h，--help | false | updateApiKeyRoles 帮助 | |
--includeCount | false | 标志，指示响应是否返回响应中的项目总数 (totalCount) | |
--itemsPerPage | int | false | 响应每页返回的项目数 |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pageNum | int | false | 显示响应返回的当前总对象设立的页面编号 |
--pretty | false | 标志，指示响应正文是否应采用美观打印格式 | |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-01-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |