Docs 菜单
Docs 主页
/
Atlas
/ /

Atlas Administration API 身份验证

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

服务帐户
API 密钥

使用行业标准 OAuth 2.0 协议并通过客户端凭证流实现 Atlas 认证的新方法。

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

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

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

创建服务帐号后,您将使用其客户端 ID 和机密生成访问令牌,用于对您的 API 请求进行身份验证。根据 OAuth 2.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进行身份验证的首选方法,请参阅向组织授予编程访问权限。

提示

后退

Admin API Overview