修改指定组织 API 密钥的角色或描述。
公共预览版： Atlas API子命令从MongoDB Atlas Admin API自动生成，提供对 Admin API的全面覆盖，目前处于公共预览阶段（请通过以下网址提供反馈：https://反馈.mongodb.com/forum/930808-Atlas-cli）。Admin API功能有自己的发布生命周期，您可以通过提供的API端点文档链接进行检查。
当您使用此命令修改组织 API 密钥的角色时，您指定的值会覆盖分配给该 API 密钥的现有角色。
要查看 apiKeyId 参数的可能值，请运行 atlas organizations apiKeys list。
要使用此命令，您必须使用具有“组织用户管理员”角色的用户帐户或 API 密钥进行身份验证。
语法
atlas organizations apiKeys assign <apiKeyId> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
apiKeyId | 字符串 | true | 标识 API 密钥的唯一的 24 位字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--desc | 字符串 | false | API 密钥的描述。 |
-h，--help | false | 分配帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--role | 字符串 | false | 要分配给API密钥的一个或多个角色。要分配多个角色，请为每个角色指定单独的角色标志，或使用一个角色标志将所有角色指定为以逗号分隔的列表。有关接受值的完整列表，请参阅相应Atlas API端点的列项枚举：https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/operation- updateapikey 。要学习；了解有关组织级别用户角色的更多信息，请参阅：https://dochub.mongodb.org/core/atlas-org-roles 。传递此标志会替换先前存在的数据。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
API Key '<Id>' successfully updated.
示例
# Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json