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.

Obter um usuário por nome

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu grupo. Para grupos existentes, o ID do grupo/ ID do 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.

Você sempre pode recuperar sua própria conta de usuário. Caso contrário, você deve ter a função Project User Admin em pelo menos um projeto que seja comum entre você e o usuário que está recuperando.

Não é possível usar esse endpoint para retornar informações sobre uma chave API. Solicite o endpoint Obter uma chave API para obter essas informações.

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /users/byName/{USER-NAME}
Parâmetro
Tipo
Descrição

USER-NAME

string

(Obrigatório.) Nome de usuário do usuário MongoDB que você deseja recuperar.

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 deve estar em um formato prettyprint.

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

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

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

Nome
Tipo
Descrição

emailAddress

string

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

Nome

string

Nome do usuário do Cloud Manager.

id

string

Identificador exclusivo do usuário do Cloud Manager.

Sobrenome

string

Sobrenome do usuário do Cloud 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 Cloud Manager.

roles

array de objetos

Atribuições de funções.

roles.groupId

string

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

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. O recurso users retorna todos os papéis que o usuário tem no Cloud Manager e MongoDB Atlas.

Os seguintes valores são válidos:

nome de usuário

string

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

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/users/byName/jane"
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 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "emailAddress" : "jane@qa.example.com", "firstName" : "Jane", "id" : "533dc19ce4b00835ff81e2eb", "lastName" : "D'oh", "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_USER_ADMIN" },{ "orgId" : "55555bbe3bd5253aea2d9b16", "roleName" : "ORG_MEMBER" } ], "links" : [], "username": "jane"}