Docs 菜单
Docs 主页
/ /
MongoDB CLI
/ / / /

mongocli iam 项目 apiKeys 创建

在此页面上

  • 语法
  • 选项
  • 继承选项
  • 输出
  • 示例

创建组织 API 密钥并将其分配给您的项目。

MongoDB 仅返回私有 API 密钥一次。 运行此命令后,请立即复制、保存并保护公共和私有 API 密钥。

要使用此命令,您必须使用具有项目用户管理员角色的用户帐户或 API 密钥进行身份验证。

命令语法
mongocli iam projects apiKeys create [options]
名称
类型
必需
说明
--desc
字符串
true
API 密钥的描述。
-h,--help
false
创建帮助
-o, --output
字符串
false
输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。
--projectId
字符串
false
标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。
--role
字符串
true
要分配给 API 密钥的一个或多个角色。 要分配多个角色,请为每个角色指定单独的角色标志,或使用一个角色标志将所有角色指定为以逗号分隔的列表。 要了解 CLI 接受哪些值,请参阅 Atlas API 规范中角色的枚举项: https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v 2 / #tag/Programmatic-API-Keys/operation/createProjectApiKey/。
名称
类型
必需
说明
-P, --profile
字符串
false

如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

API Key '<ID>' created.
Public API Key <PublicKey>
Private API Key <PrivateKey>
# Create an organization API key with the ORG_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
mongocli iam projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role ORG_OWNER --output json

后退

分配