Docs 菜单
Docs 主页
/
MongoDB Atlas
/
程序化访问
/
Atlas Administration API
/
开始体验

管理对组织的编程访问

在此页面上

  • 必需的访问权限
  • 查看对组织的编程访问权限
  • 更新对组织的编程访问权限
  • 撤销对组织的编程访问权限

使用以下过程管理组织的编程访问权限。 要了解详情，请参阅向组织授予编程访问权限。

必需的访问权限

要执行以下任何操作，您必须拥有 Atlas 的 Organization Owner 访问权限。

查看对组织的编程访问权限

您可以查看有权访问权限组织的所有 API密钥或服务帐户的详细信息。

您可以使用 Atlas CLI 查看组织中的 API 密钥列表、API 密钥的详细信息或API密钥的访问列表。

查看 API 密钥

要使用 Atlas CLI 列出组织中的所有 API 密钥，请运行以下命令：

atlas organizations apiKeys list [options]

要使用 Atlas CLI 返回组织中 API 密钥的详细信息，请运行以下命令：

atlas organizations apiKeys describe <ID> [options]

要学习；了解有关上述命令的语法和参数的更多信息，请参阅Atlas CLI文档中的 Atlas organizations apiKeys list和Atlas organizations apiKeys describe。

查看API密钥的API访问列表条目

要使用 Atlas CLI 列出 API 密钥的 IP 访问列表条目，请运行以下命令：

atlas organizations apiKeys accessLists list <apiKeyID> [options]

要学习；了解有关命令语法和参数的更多信息，请参阅 Atlas organizations apiKeys accessLists list的Atlas CLI文档。

要使用Atlas用户界面查看组织中API密钥的详细信息，请执行以下操作：

1

在 Atlas 中，转到 Organization Access Manager（项目集成）页面。

  1. 如果尚未显示，组织从导航栏中的Organizations菜单。

  2. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Organization Access 。

    • 单击侧边栏中的 Access Manager（支持）。

    显示“组织访问经理”页面。

2

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

查看访问列表。

  1. 单击在API密钥右侧。

  2. 单击 View Details（连接）。

<Public Key> API Key Details模式显示：

  • 混淆后的 Private Key

  • 上次使用密钥的日期

  • 创建密钥的日期

  • 密钥可以访问权限 API 的 IP 地址

  • 已授予密钥访问权限的项目

1

在 Atlas 中，转到 Organization Access Manager（项目设置）页面。

  1. 如果尚未显示，组织从导航栏中的Organizations菜单。

  2. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Organization Access 。

    • 单击侧边栏中的 Access Manager（支持）。

    显示“组织访问经理”页面。

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

列出有权访问权限组织的所有服务帐户。

单击服务帐户名称可查看其详细信息，包括：

  • 服务帐户的混淆客户端密钥

  • 上次使用客户端密钥的日期

  • 创建客户端密钥的日期

  • 服务帐户可以访问权限API的IP地址

  • 已为服务帐户分配的角色

您可以使用Atlas Administration API列出有权访问权限组织的服务帐户的名称和详细信息。

更新对组织的编程访问权限

您可以使用 Atlas CLI 更改组织中 API 密钥的角色或访问列表。

更改API密钥的角色

要使用 Atlas CLI 更新组织中的 API 密钥，请运行以下命令：

atlas organizations apiKeys assign <apiKeyId> [options]

要学习；了解有关命令语法和参数的更多信息，请参阅 Atlas组织 apiKeys 分配的Atlas CLI文档。

为API密钥添加API访问列表条目

要使用 Atlas CLI 创建 API 密钥的 IP 访问列表条目，请运行以下命令：

atlas organizations apiKeys accessLists create [options]

要了解有关命令语法和参数的更多信息，请参阅 Atlas CLI 文档中的 atlas organizations apiKeys accessLists create。

删除API密钥的API访问列表条目

要使用 Atlas CLI 删除 API 密钥的 IP 访问列表条目，请运行以下命令：

atlas organizations apiKeys accessLists delete <entry> [options]

要学习；了解有关命令语法和参数的更多信息，请参阅 Atlas组织 apiKeys accessLists 删除的Atlas CLI文档。

您可以使用Atlas 用户界面更改组织中API密钥的角色、描述或访问权限列表。

1

在 Atlas 中，转到 Organization Access Manager（项目设置）页面。

  1. 如果尚未显示，组织从导航栏中的Organizations菜单。

  2. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Organization Access 。

    • 单击侧边栏中的 Access Manager（支持）。

    显示“组织访问经理”页面。

2

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

在要更改的 API 密钥右侧的省略号菜单中，单击Edit 。

5

编辑API Key Information 。

在 Add API Key 页面中：

  1. 修改Description 。

  2. 在 Organization Permissions 菜单中选择 API 密钥 的一个或多个新角色。

6

单击 Next（保存并关闭）。

7

编辑API Access List 。

  1. 要添加您希望Atlas接受对此 API 密钥的 API 请求的 IP 解决或 CIDRAdd Access list Entry 区块，请单击 并键入 IP 解决。

    Use Current IP Address如果您用于访问权限Atlas的托管也将使用此 API 密钥发出 API 请求，您也可以单击 。

  2. 要从访问权限列表中删除IP解决，请单击在IP解决右侧。

  3. 单击 Save（连接）。

8

单击 Done（保存并关闭）。

您可以使用Atlas 用户界面更改组织中服务帐户的角色、名称、描述或访问权限列表。 您还可以生成新的客户端密钥。

1

在 Atlas 中，转到 Organization Access Manager（项目设置）页面。

  1. 如果尚未显示，组织从导航栏中的Organizations菜单。

  2. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Organization Access 。

    • 单击侧边栏中的 Access Manager（支持）。

    显示“组织访问经理”页面。

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

4

单击服务帐户的名称。

5

编辑Service Account Info 。

要修改Name 或Description ，请单击 。

6

生成新的客户端密钥。

  1. 单击 Generate New Client Secret

  2. 从菜单中选择客户端密钥的持续时间。 客户端密钥在此持续时间后过期。

  3. 单击 Generate New（连接）。

  4. 单击 Copy 并将客户端密钥保存到安全位置。这是您唯一一次可以查看完整的客户端密钥。

7

编辑Organization Permissions 。

  1. 单击 Edit Permissions（连接）。

  2. 从Organization Permissions 菜单中，为服务帐户选择一个或多个新角色。

  3. 单击 Save and next（连接）。

    重要

    服务帐户凭证将保持活动状态，直到过期或被撤销。

8

编辑API Access List 。

  1. 要添加您希望Atlas接受针对此服务帐户的API请求的IP解决或 CIDR区块，请单击Add Access List Entry 并键入IP解决。

    Use Current IP Address如果您用于访问权限Atlas的托管也将使用此服务帐号发出API请求，您也可以单击 。

  2. 要从访问权限列表中删除IP解决，请单击在IP解决右侧。

  3. 单击 Save（连接）。

撤销对组织的编程访问权限

要使用 Atlas CLI 从组织中删除 API 密钥，请运行以下命令：

atlas organizations apiKeys delete <ID> [options]

要学习；了解有关命令语法和参数的更多信息，请参阅 Atlas organizations apiKeys 删除的Atlas CLI文档。

要删除组织中API密钥的访问权限列表条目，请参阅更新对组织的编程访问权限。

1

在 Atlas 中，转到 Organization Access Manager（项目设置）页面。

  1. 如果尚未显示，组织从导航栏中的Organizations菜单。

  2. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Organization Access 。

    • 单击侧边栏中的 Access Manager（支持）。

    显示“组织访问经理”页面。

2

单击 Applications（私有端点）标签页。

3

单击 API Keys（保存并关闭）。

4

单击要删除的API密钥右侧的 。

5

单击Delete 以确认您要删除此API密钥，或单击 Cancel以将密钥保留在组织中。

从组织中删除API密钥也会从该密钥被授予访问权限的任何项目中删除该密钥。

1

在 Atlas 中，转到 Organization Access Manager（项目设置）页面。

  1. 如果尚未显示，组织从导航栏中的Organizations菜单。

  2. 执行以下步骤之一：

    • 从导航栏的Access Manager菜单中选择Organization Access 。

    • 单击侧边栏中的 Access Manager（支持）。

    显示“组织访问经理”页面。

2

单击 Applications（私有端点）标签页。

3

单击 Service Accounts（保存并关闭）。

4

删除服务帐户。

  1. Actions单击要删除的服务帐户右侧 下的图标。

  2. 单击 Delete（连接）。

从组织中删除服务帐户还会将其从服务帐户被授予访问权限的任何项目中删除。

您可以使用Atlas Administration API执行以下操作：

后退

开始体验

来年

多个组织