创建一个 MongoDB Cloud 用户 | Atlas Admin API v2 文档 (2023-02-01)

创建一个 MongoDB Cloud 用户已弃用

发布 /api/atlas/v2/users

创建一个 MongoDB Cloud 用户帐户。MongoDB Cloud 用户帐户仅授予对 MongoDB Cloud 应用程序的访问权限。要授予数据库访问权限，请创建数据库用户。MongoDB Cloud 会向您指定的用户发送电子邮件，邀请他们加入项目。受邀用户在接受邀请之前无权访问该项目。邀请将在 30 天后过期。

MongoDB Cloud 将 MongoDB Cloud 用户成员数限制为每个团队最多 250 名 MongoDB Cloud 用户。MongoDB Cloud 将 MongoDB Cloud 用户成员数限制为每个项目 500 个 MongoDB Cloud 用户和每个组织 500 个 MongoDB Cloud 用户，其中包括组织所有项目的成员数量总和。如果操作超出这些限制，MongoDB Cloud 会引发错误。例如，如果组织有 5 个项目，每个项目有 100 个 MongoDB Cloud 用户，并且每个 MongoDB Cloud 用户仅属于一个项目，那么如果不先从组织中删除现有 MongoDB Cloud 用户的情况下，您无法向此组织添加任何 MongoDB Cloud 用户。

要使用此资源，请求的服务账户或 API 密钥可以具有任何角色。

查询参数

envelope 布尔

指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

默认值为false 。
pretty 布尔

指示响应正文是否应采用 prettyprint 格式的标记。

默认值为false 。

Prettyprint

application/vnd.atlas.2023-01-01+json

body 必需

要创建的 MongoDB Cloud 用户帐户。

国家字符串必需

两个字母字符，用于标识 MongoDB Cloud 用户的地理位置。此参数使用 ISO 3166-1a2 代码格式。

格式应符合以下模式：^([A-Z]{2})$。
名字符串必需

属于 MongoDB Cloud 用户的名或姓。
姓字符串必需

属于 MongoDB Cloud 用户的姓氏。
mobileNumber 字符串必需

属于 MongoDB Cloud 用户的手机号码。

格式应符合以下模式：(?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$。
密码 string(password) 必需

密码与用户名一起应用以登录 MongoDB Cloud。MongoDB Cloud 不会返回此参数，除非响应创建新的 MongoDB Cloud 用户。从 MongoDB Cloud 控制台设置密码后，只有 MongoDB Cloud 用户可以更新其密码。

最小长度为 8。
角色大量[对象]

显示 MongoDB Cloud 用户角色以及该角色适用的相应组织或项目的对象列表。一个角色可应用于一个组织或一个项目，但不能同时应用于两者。

MongoDB Cloud 用户的角色以及该角色适用的相应组织或项目。每个角色只能应用一个组织或一个项目，但不能同时应用于两者。
隐藏角色属性显示角色属性对象
- groupId 字符串
  
  唯一的24 -十六进制数字字符串，用于标识此角色所属的项目。您可以为此参数或 orgId设立值，但不能在同一请求中同时设置两者。
  
  最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。
- orgId 字符串
  
  唯一的24 -十六进制数字字符串，用于标识此角色所属的组织。您可以为此参数或 groupId设立值，但不能在同一请求中同时设置两者。
  
  最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。
- roleName 字符串
  
  人类可读标签，用于标识MongoDB Cloud 授予特定API密钥、 MongoDB Cloud 用户或MongoDB Cloud团队的权限集合。这些角色包括组织级角色和项目级角色。
  
  值为 ORG_MEMBER、ORG_READ_ONLY、ORG_STREAM_PROCESSING_ADMIN、ORG_BILLING_ADMIN、ORG_BILLING_READ_ONLY、ORG_GROUP_CREATOR、ORG_OWNER、GROUP_OWNER、GROUP_READ_ONLY、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、 GROUP_CLUSTER_MANAGER、GROUP_SEARCH_INDEX_EDITOR、GROUP_STREAM_PROCESSING_OWNER、GROUP_BACKUP_MANAGER、GROUP_OBSERVABILITY_VIEWER 或 GROUP_DATABASE_ACCESS_ADMIN。
用户名 string(电子邮件) 必需

代表 MongoDB Cloud 用户的用户名的电子邮件地址。

响应

200 application/vnd.atlas.2023-01-01+json

正常
隐藏响应属性显示响应属性对象
- 国家字符串必需
  
  两个字母字符，用于标识 MongoDB Cloud 用户的地理位置。此参数使用 ISO 3166-1a2 代码格式。
  
  格式应符合以下模式：^([A-Z]{2})$。
- createdAt string(date-time)
  
  创建当前帐户的日期和时间。此值采用 UTC 格式的 ISO 8601 时间戳。
- 邮箱 string(电子邮件) 必需已弃用
  
  MongoDB Cloud 用户的电子邮件解决。
- 名字符串必需
  
  属于 MongoDB Cloud 用户的名或姓。
- id 字符串
  
  唯一的 24 位十六进制数字字符串，用于标识 MongoDB Cloud 用户。
  
  格式应符合以下模式：^([a-f0-9]{24})$。
- lastAuth string(date-time)
  
  当前帐户上次进行身份验证的日期和时间。此值采用 UTC 格式的 ISO 8601 时间戳。
- 姓字符串必需
  
  属于 MongoDB Cloud 用户的姓氏。
- 链接大量[对象]
  
  点API子资源、相关API资源或两者的一个或多个统一资源定位符 (URL) 的列表。 RFC 5988 概述了这些关系。
  
  Web 链接规范 (RFC 5988)
  
  隐藏链接属性显示链接属性对象
  
  href 字符串
  
  统一资源定位符 (URL )，指向与此响应有某种关系的另一个API资源。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
  
  rel 字符串
  
  统一资源定位符 (URL )，定义此资源与另一个API资源之间的语义关系。此URL通常以 https://cloud.mongodb.com/api/atlas 开头。
- mobileNumber 字符串必需
  
  属于 MongoDB Cloud 用户的手机号码。
  
  格式应符合以下模式：(?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$。
- 密码 string(password) 必需
  
  密码与用户名一起应用以登录 MongoDB Cloud。MongoDB Cloud 不会返回此参数，除非响应创建新的 MongoDB Cloud 用户。从 MongoDB Cloud 控制台设置密码后，只有 MongoDB Cloud 用户可以更新其密码。
  
  最小长度为 8。
- 角色大量[对象]
  
  显示 MongoDB Cloud 用户角色以及该角色适用的相应组织或项目的对象列表。一个角色可应用于一个组织或一个项目，但不能同时应用于两者。
  
  MongoDB Cloud 用户的角色以及该角色适用的相应组织或项目。每个角色只能应用一个组织或一个项目，但不能同时应用于两者。
  
  隐藏角色属性显示角色属性对象
  
  groupId 字符串
  
  唯一的24 -十六进制数字字符串，用于标识此角色所属的项目。您可以为此参数或 orgId设立值，但不能在同一请求中同时设置两者。
  
  最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。
  
  orgId 字符串
  
  唯一的24 -十六进制数字字符串，用于标识此角色所属的组织。您可以为此参数或 groupId设立值，但不能在同一请求中同时设置两者。
  
  最小长度为 24，最大长度为 24。格式应符合以下模式：^([a-f0-9]{24})$。
  
  roleName 字符串
  
  人类可读标签，用于标识MongoDB Cloud 授予特定API密钥、 MongoDB Cloud 用户或MongoDB Cloud团队的权限集合。这些角色包括组织级角色和项目级角色。
  
  值为 ORG_MEMBER、ORG_READ_ONLY、ORG_STREAM_PROCESSING_ADMIN、ORG_BILLING_ADMIN、ORG_BILLING_READ_ONLY、ORG_GROUP_CREATOR、ORG_OWNER、GROUP_OWNER、GROUP_READ_ONLY、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、 GROUP_CLUSTER_MANAGER、GROUP_SEARCH_INDEX_EDITOR、GROUP_STREAM_PROCESSING_OWNER、GROUP_BACKUP_MANAGER、GROUP_OBSERVABILITY_VIEWER 或 GROUP_DATABASE_ACCESS_ADMIN。
- teamIds array[string]
  
  唯一的 24-十六进制数字字符串列表，用于标识此MongoDB Cloud 用户所属的团队。
  
  每个的格式应符合以下模式：^([a-f0-9]{24})$。
- 用户名 string(电子邮件) 必需
  
  代表 MongoDB Cloud 用户的用户名的电子邮件地址。
401 application/json

未经授权。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
403 application/json

Forbidden.
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
404 application/json

未找到。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。
500 application/json

内部服务器错误。
隐藏响应属性显示响应属性对象
- badRequestDetail 对象
  
  错误请求详情。
  
  隐藏 BadRequestDetail 属性显示 BadRequestDetail 属性对象
  
  字段大量[对象]
  
  描述客户端请求中的所有违规行为。
  
  隐藏字段属性显示字段属性对象
  
  描述字符串必需
  
  关于请求元素错误的原因的描述。
  
  字段字符串必需
  
  指向请求正文中字段的路径。
- 详细信息字符串
  
  描述导致每种错误类型的具体条件或原因。
- 错误 integer(int32) 必需
  
  与此错误一起返回的 HTTP 状态代码。
  
  外部文档
- 错误代码字符串必需
  
  返回此错误时附带应用程序错误代码。
- 参数大量[对象]
  
  用于提供更多错误信息的参数。
- 原因字符串
  
  随此错误返回的应用程序错误消息。

POST /api/atlas/v2 /users

atlas api mongoDbCloudUsers createUser --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230201001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateUserApiParams{}
	sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
		CreateUserWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'

请求示例

{
  "country": "string",
  "firstName": "string",
  "lastName": "string",
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ],
  "username": "hello@example.com"
}

响应示例 (200)

{
  "country": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "emailAddress": "hello@example.com",
  "firstName": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastAuth": "2025-05-04T09:42:00Z",
  "lastName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ],
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com"
}

响应示例 (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

响应示例 (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

响应示例 (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

响应示例 (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}

创建一个 MongoDB Cloud 用户 已弃用

查询参数

body 必需

响应

创建一个 MongoDB Cloud 用户已弃用