Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Criar um usuário

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O ponto de extremidade permanece conforme indicado no documento.

Criar um novo usuário. Por padrão, qualquer organização não global e roles de projeto na carga útil enviam aos usuários um convite para a organização ou projeto primeiro.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /users

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta está em um formato pretty-print.

false

envelope

booleano

Opcional

Sinalizador que indica se deve envolver a resposta em um 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 query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

Todos os campos são obrigatórios.

Nome
Tipo
Descrição

nome de usuário

string

Nome de usuário do usuário do Ops Manager. Validado dependendo do valor da propriedade mms.email.validation :

  • false: (Padrão) Não é necessário que o nome de usuário seja um endereço de e-mail.

  • loose: O nome de usuário deve conter um símbolo @ seguido de um ponto.

  • strict: O nome de usuário deve aderir a uma expressão regular rigorosa de validação de endereço de e-mail.

Consulte mms.email.validation para obter detalhes.

Senha

string

Senha do usuário do Ops Manager.

Este campo não está incluído na entidade retornada do servidor. Ele pode ser enviado somente no corpo da entidade quando você cria um novo usuário.

emailAddress

string

Endereço de e-mail do usuário do Ops Manager.

mobileNumber

string

Número de telefone celular do usuário do Ops Manager.

Nome

string

Nome do usuário do Ops Manager.

Sobrenome

string

Sobrenome do usuário do Ops Manager.

roles

array de objetos

Atribuições de role do usuário do Ops Manager.

roles.orgId

string

Identificador único da organização na qual o usuário do Ops Manager tem o papel especificado.

roles.groupId

string

Identificador único do grupo no qual o usuário do Ops Manager tem o role especificado.

Para as roles "globais" (aquelas cujo nome começa com GLOBAL_), não há groupId , pois essas roles não estão vinculadas a um grupo.

roles.roleName

string

Nome da função. Os valores aceitos são:

O documento JSON contém cada um dos seguintes elementos:

Name
Tipo
Descrição

emailAddress

string

Endereço de e-mail do usuário do Ops Manager.

firstName

string

Nome do usuário do Ops Manager.

id

string

Identificador único do usuário do Ops Manager.

lastName

string

Sobrenome do usuário do Ops Manager.

links

array de objetos

Links para sub-recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. O relacionamento entre URLs é explicado na Especificação de links da web.

mobileNumber

string

Número de celular do usuário do Ops Manager.

roles

Array vazia

Função atribuída ao usuário do Ops Manager.

roles
.groupId

string

Identificador único do projeto no qual o usuário tem o papel especificado.

As funções que começam com GLOBAL_ não exigem um groupId. Essas funções não estão vinculadas a um projeto.

roles
.orgId

string

Identificador único para a organização na qual o usuário tem o papel especificado.

roles
.roleName

string

Nome da função. Os valores aceitos são:

username

string

Nome de usuário do usuário do Ops Manager.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/users" \ --data ' { "username": "jane.doe@mongodb.com", "emailAddress": "jane.doe@mongodb.com", "firstName": "Jane", "lastName": "Doe", "password": "M0ng0D8!:)", "roles": [{ "groupId": "533daa30879bb2da07807696", "roleName": "GROUP_USER_ADMIN" },{ "orgId" : "55555bbe3bd5253aea2d9b16", "roleName" : "ORG_MEMBER" }] }'
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "id" : "533dc19ce4b00835ff81e2eb", "username" : "jane.doe@mongodb.com", "emailAddress" : "jane.doe@mongodb.com", "firstName" : "Jane", "lastName" : "Doe", "roles" : [], "links" : []}