Obter um usuário por nome
Nesta página
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 ser umusuário global ou 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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /users/byName/{USER-NAME}
Parâmetros do caminho da solicitação
Parâmetro | Tipo | Descrição |
|---|---|---|
USER-NAME | string | (Obrigatório.) Nome de usuário do usuário MongoDB que você deseja recuperar. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. | 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:
| 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 Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
Nome | string | Nome do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
id | string | Identificador único do usuário do Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
Sobrenome | 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 de objetos | Atribuições de funções. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único do projeto no qual o usuário tem o papel especificado. Para os roles "globais" (aqueles cujo nome começa com | ||||||||||||||||||||||||||||||||||||||||
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 são:
| ||||||||||||||||||||||||||||||||||||||||
nome de usuário | string | Nome de usuário do usuário do Ops Manager. |
Exemplo de solicitação
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<ops-manager-host>/api/public/v1.0/users/byName/jane"
Exemplo de resposta
Cabeçalho de resposta
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
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
{ "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" }