Docs 菜单

Atlas Administration API 身份验证

您可以使用以下两种方法之一对Atlas Administration API进行身份验证:

服务帐户
API 密钥

New method of authenticating to Atlas using the industry standard OAuth 2.0 protocol with the Client Credentials flow.

使用HTTP摘要式身份验证向Atlas进行身份验证的传统方法。

服务帐户允许您管理权限和创建访问权限令牌。 服务帐户具有客户端ID和密钥,密钥可用作创建访问权限令牌的用户名和密码。 访问权限令牌允许您向Atlas发出API请求。

API密钥分为两部分:公钥和私钥。当您向Atlas发出API请求时,这两个部分的提供服务与用户名和密码相同。

创建服务帐户后,您将使用其客户端ID和密钥生成访问权限令牌,以对API请求进行身份验证。根据 OAuth2.0 规范,访问令牌的有效期仅为 1小时( 秒)。3600访问权限令牌过期可以防止重放攻击,因为在重放攻击中,可以不受时间限制地使用泄露的访问权限令牌。

Atlas 使用一个称为 nonce 的唯一值对公钥和私钥进行哈希化处理。根据 HTTP 摘要式身份验证规范,nonce 的有效期很短。这是为了防止重放攻击,因此您不能缓存 nonce 并永远使用它。

Atlas角色限制服务帐户可以使用其访问权限令牌执行的操作。您必须像向用户授予角色一样向服务帐户授予角色,以确保访问权限令牌可以调用API端点而不会出现错误。

Atlas角色限制API密钥可以执行的操作。您必须向API密钥授予角色,就像向用户授予角色一样,以确保API密钥可以调用API端点而不会出错。

Atlas将许多资源绑定到一个项目。 许多API资源URL都遵循 /api/atlas/<version>/groups/<GROUP-ID>/<GROUP-ID>的格式,其中 是您的项目ID 。对于这些资源,服务帐户必须是托管项目的组织的成员。 否则, Atlas将返回401 错误进行响应。要授予组织级服务帐户对项目的访问权限,请参阅为项目分配现有组织访问权限。

Atlas将许多资源绑定到一个项目。 许多API资源URL都遵循 /api/atlas/<version>/groups/<GROUP-ID>/<GROUP-ID>的格式,其中 是您的项目ID 。对于这些资源, API密钥必须是托管项目的组织的成员。否则, Atlas将返回401 错误进行响应。要授予组织级API密钥对项目的访问权限,请参阅为项目分配现有组织访问权限。

每个服务帐号仅属于一个组织,但您可以授予服务帐号访问权限,以访问该组织中任意数量的项目。

每个API密钥只属于一个组织,但您可以向该组织中任意数量的项目授予API密钥访问权限。

您无法使用服务帐户或其访问令牌通过 Atlas 用户界面登录 Atlas。

您无法使用API密钥通过Atlas用户界面日志Atlas

要配置对Atlas Administration API进行身份验证的首选方法,请参阅向组织授予编程访问权限。

另请参阅: