Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos da API de administração do Cloud Manager
/
Projetos e usuários
/
Usuários

Obter um usuário por ID

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

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 grupo de termos mais conhecido ao se referir às descrições. O ponto final 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

Resource

GET /users/{USER-ID}

Parâmetros do caminho da solicitação

Parâmetro
Tipo
Descrição
ID DE USUÁRIO
string
(Obrigatório.) Identificador exclusivo do usuário que você deseja recuperar. Para recuperar o USER-ID para um usuário, consulte Obter todos os usuários em um projeto.

Solicitar parâmetros de query

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

Nome
Tipo
necessidade
Descrição
default
pretty
booleano
Opcional
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da 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:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

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

Resposta

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:

Valor
Descrição
ORG_MEMBER
ORG_READ_ONLY
ORG_BILLING_ADMIN
ORG_GROUP_CREATOR
ORG_OWNER
GROUP_ATLAS_ADMIN
Project Admin (Atlas)
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN
GROUP_BILLING_ADMIN
Administrador de faturamento do projeto
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
nome de usuário
string
Nome de usuário do usuário do Cloud Manager.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/users/533dc19ce4b00835ff81e2eb"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Corpo de resposta

{
  "id" : "533dc19ce4b00835ff81e2eb",
  "username" : "jane",
  "emailAddress" : "jane@qa.example.com",
  "firstName" : "Jane",
  "lastName" : "D'oh",
  "roles" : [ {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  } ],
  "links" : [],
  "username": "jane"
}

Voltar

Usuários