Criar um usuário da nuvem MongoDB Obsoleto(a)

POSTAR /api/atlas/v2/users

Cria uma conta de usuário do MongoDB Cloud. Uma conta de usuário do MongoDB Cloud concede acesso apenas ao aplicativo do MongoDB Cloud. Para conceder acesso ao banco de dados, crie um usuário de banco de dados. O MongoDB Cloud envia um e-mail para os usuários que você especificar, convidando-os para participar do projeto. Os usuários convidados não terão acesso ao projeto até que aceitem o convite. Os convites expiram após 30 dias.

O MongoDB Cloud limita a adesão de usuários do MongoDB Cloud a um máximo de 250 por equipe. O MongoDB Cloud limita a adesão de usuários do MongoDB Cloud a 500 por projeto e 500 por organização, o que inclui a adesão combinada de todos os projetos na organização. O MongoDB Cloud emitirá um erro se uma operação exceder esses limites. Por exemplo, se você tiver uma organização com cinco projetos e cada projeto tiver 100 usuários do MongoDB Cloud, e cada usuário pertencer a apenas um projeto, não será possível adicionar nenhum usuário a essa organização sem primeiro remover os usuários existentes da organização.

Para usar este recurso, a conta de serviço ou a chave de API solicitante pode ter qualquer função.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

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

corpo, corpo Obrigatório

Conta de usuário do MongoDB Cloud a ser criada.

  • País string Obrigatório

    Dois caracteres alfabéticos que identificam a localização geográfica do usuário do MongoDB Cloud. Este parâmetro utiliza o formato de código ISO 3166-1a2.

    O formato deve corresponder ao seguinte padrão: ^([A-Z]{2})$.

  • Nome string Obrigatório

    Nome que pertence ao usuário do MongoDB Cloud.

  • Sobrenome string Obrigatório

    Sobrenome que pertence ao usuário MongoDB Cloud.

  • mobileNumber string Obrigatório

    Número de celular que pertence ao usuário MongoDB Cloud.

    O formato deve corresponder ao seguinte padrão: (?:(?:\\+?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})$.

  • Senha string(senha) Obrigatório

    Senha aplicada com o nome de usuário para conectar ao MongoDB Cloud. O MongoDB Cloud não retorna esse parâmetro, exceto em resposta à criação de um novo usuário do MongoDB Cloud. Somente o usuário do MongoDB Cloud pode atualizar sua senha depois que ela tiver sido definida no console do MongoDB Cloud.

    O comprimento mínimo é 8.

  • roles array[objeto]

    Lista de objetos que exibem as roles do usuário do MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Uma role pode se aplicar a uma organização ou a um projeto, mas não a ambos.

    As roles do usuário da MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Cada função pode ser aplicada a uma organização ou a um projeto , mas não a ambos.

    Ocultar atributos de roles Mostrar atributos de funções objeto
    • groupId string

      24String única de dígitos hexadecimais que identifica o projeto ao qual esta role pertence. Você pode definir um valor para esse parâmetro ou orgId, mas não ambos na mesma solicitação.

      O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • orgId string

      24String única de dígitos hexadecimais que identifica a organização à qual pertence esta função. Você pode definir um valor para esse parâmetro ou groupId, mas não ambos na mesma solicitação.

      O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • roleName string

      Etiqueta legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a uma chave de API específica, a um usuário do MongoDB Cloud ou a uma equipe do MongoDB Cloud. Essas funções incluem funções de nível de organização e de projeto.

      Os valores são 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 ou GROUP_DATABASE_ACCESS_ADMIN.

  • nome de usuário string(e-mail) Obrigatório

    Endereço de e-mail que representa o nome de usuário do MongoDB Cloud.

Respostas

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

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • País string Obrigatório

      Dois caracteres alfabéticos que identificam a localização geográfica do usuário do MongoDB Cloud. Este parâmetro utiliza o formato de código ISO 3166-1a2.

      O formato deve corresponder ao seguinte padrão: ^([A-Z]{2})$.

    • createdAt string(data-hora)

      Data e hora em que a conta atual é criada. Esse valor está no formato de carimbo de data/hora ISO 8601 em UTC.

    • emailAddress string(e-mail) Obrigatório Obsoleto(a)

      Endereço de e-mail que pertence ao usuário MongoDB Cloud.

    • Nome string Obrigatório

      Nome que pertence ao usuário do MongoDB Cloud.

    • id string

      String exclusiva de 24 dígitos hexadecimais que identifica o usuário do MongoDB Cloud.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • lastAuth string(data-hora)

      Data e hora em que a conta atual foi autenticada pela última vez. Esse valor está no formato de carimbo de data/hora ISO 8601 em UTC.

    • Sobrenome string Obrigatório

      Sobrenome que pertence ao usuário MongoDB Cloud.

    • mobileNumber string Obrigatório

      Número de celular que pertence ao usuário MongoDB Cloud.

      O formato deve corresponder ao seguinte padrão: (?:(?:\\+?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})$.

    • Senha string(senha) Obrigatório

      Senha aplicada com o nome de usuário para conectar ao MongoDB Cloud. O MongoDB Cloud não retorna esse parâmetro, exceto em resposta à criação de um novo usuário do MongoDB Cloud. Somente o usuário do MongoDB Cloud pode atualizar sua senha depois que ela tiver sido definida no console do MongoDB Cloud.

      O comprimento mínimo é 8.

    • roles array[objeto]

      Lista de objetos que exibem as roles do usuário do MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Uma role pode se aplicar a uma organização ou a um projeto, mas não a ambos.

      As roles do usuário da MongoDB Cloud e a organização ou projeto correspondente ao qual essa role se aplica. Cada função pode ser aplicada a uma organização ou a um projeto , mas não a ambos.

      Ocultar atributos de roles Mostrar atributos de funções objeto
      • groupId string

        24String única de dígitos hexadecimais que identifica o projeto ao qual esta role pertence. Você pode definir um valor para esse parâmetro ou orgId, mas não ambos na mesma solicitação.

        O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • orgId string

        24String única de dígitos hexadecimais que identifica a organização à qual pertence esta função. Você pode definir um valor para esse parâmetro ou groupId, mas não ambos na mesma solicitação.

        O comprimento mínimo é 24, o comprimento máximo é 24. O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • roleName string

        Etiqueta legível por humanos que identifica a coleção de privilégios que o MongoDB Cloud concede a uma chave de API específica, a um usuário do MongoDB Cloud ou a uma equipe do MongoDB Cloud. Essas funções incluem funções de nível de organização e de projeto.

        Os valores são 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 ou GROUP_DATABASE_ACCESS_ADMIN.

    • teamIds array[string]

      Lista de strings exclusivas de 24dígitos hexadecimais que identifica as equipes às quais esse usuário do MongoDB Cloud pertence.

      O formato de cada um deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • nome de usuário string(e-mail) Obrigatório

      Endereço de e-mail que representa o nome de usuário do MongoDB Cloud.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

atlas api mongoDbCloudUsers createUser --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.2025-03-12+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.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'
Exemplos de solicitação
{
  "country": "string",
  "firstName": "string",
  "lastName": "string",
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "ORG_MEMBER"
    }
  ],
  "username": "hello@example.com"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}