文档菜单
文档首页
/ /
MongoDB CLI
/ / / /

mongocli iam projects apiKeys assign

在本页

  • 语法
  • 参数
  • 选项
  • 继承选项
  • 示例

将指定的组织API密钥分配到您的项目,并修改项目中的API密钥角色。

使用此命令修改组织API密钥的角色时,您指定的值将覆盖分配给API密钥的现有角色。

要查看ID参数的可能值,请运行mongocli iam organizations apiKeys list。

命令语法
mongocli iam projects apiKeys assign <ID> [options]
名称
类型
必需
描述
标识符
字符串
一个独特的24位字符串,用于标识您的API密钥。
名称
类型
必需
描述
-h, --help
assign的帮助信息
-o, --output
字符串
输出格式。有效值是json、json-path、go-template或go-template-file。要查看完整的输出,请使用-o json选项。
--projectId
字符串
用于标识要使用项目的十六进制字符串。此选项会覆盖配置文件或环境变量中的设置。
--role
字符串
您要分配给API密钥的角色或角色列表。要分配多个角色,请使用单独的角色标志指定每个角色,或使用一个角色标志以逗号分隔列表指定所有角色。要了解CLI接受的值,请参阅Atlas API规范中角色的Items Enumhttps://mongodb.ac.cn/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/.
名称
类型
必需
描述
-P, --profile
字符串
从配置文件中使用的配置文件配置文件名称。有关MongoCLI配置文件中配置文件的详细信息,请参阅https://dochub.mongodb.org/core/atlas-cli-configuration-file.
# Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3:
mongocli iam projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json

返回

API密钥