Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs Menu
Docs Home
/ /

Obtener un usuario mediante ID

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es lo mismo que tu ID del grupo. Para los grupos existentes, su identificador de grupo/proyecto sigue siendo el mismo. Esta página utiliza el término más familiar "grupo" al referirse a descripciones. El endpoint permanece como se indica en el documento.

Siempre puedes recuperar tu propia cuenta de usuario. De lo contrario, debes ser un usuario global o debes tener el rol de Project User Admin en al menos un proyecto que sea común entre tú y el usuario del que recuperas información.

No puedes usar este endpoint para devolver la información de una Clave API. Solicita el endpoint Get One API Key para obtener esta información.

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

GET /users/{USER-ID}
Parameter
Tipo
Descripción

ID de usuario

string

(Obligatorio). Identificador único del usuario que deseas recuperar. Para recuperar el USER-ID de un usuario, consulta Obtener todos los usuarios en un proyecto.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuesta HTTP

content

Cuerpo de respuesta esperado

false

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

El documento HTTP contiene cada uno de los siguientes elementos:

Nombre
Tipo
Descripción

Dirección de correo electrónico

string

Dirección de correo electrónico del usuario Ops Manager

Nombre

string

Primer nombre del usuario de Ops Manager.

ID

string

Identificador único del usuario de Ops Manager.

Apellidos

string

Apellido del usuario de Ops Manager.

enlaces

objeto arreglo

Enlaces hacia recursos secundarios relacionados. Todos los links arreglos en las respuestas incluyen al menos un vínculo llamado self. La relación entre las URLs se explica en la Especificación de Enlace Web.

Número de teléfono móvil

string

Número de móvil del usuario de Ops Manager.

Roles

objeto arreglo

Asignaciones de roles.

roles.groupId

string

Identificador único para el Proyecto en el que el usuario tiene el rol especificado.

Para los roles "globales" (aquellos cuyo nombre comienza con GLOBAL_) no existe un groupId ya que estos roles no están vinculados a un proyecto.

roles.orgId

string

Identificador único de la organización en la que el usuario tiene el rol especificado.

roles.roleName

string

Nombre del rol. Los valores son:

Valor
Descripción

ORG_MEMBER

ORG_READ_ONLY

ORG_GROUP_CREATOR

ORG_OWNER

GROUP_AUTOMATION_ADMIN

GROUP_BACKUP_ADMIN

GROUP_MONITORING_ADMIN

GROUP_OWNER

GROUP_READ_ONLY

GROUP_USER_ADMIN

GROUP_DATA_ACCESS_ADMIN

GROUP_DATA_ACCESS_READ_ONLY

GROUP_DATA_ACCESS_READ_WRITE

GLOBAL_AUTOMATION_ADMIN

GLOBAL_BACKUP_ADMIN

GLOBAL_MONITORING_ADMIN

GLOBAL_OWNER

GLOBAL_READ_ONLY

GLOBAL_USER_ADMIN

Nombre de usuario

string

Nombre de usuario del usuario de Ops Manager.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://<ops-manager-host>/api/public/v1.0/users/533dc19ce4b00835ff81e2eb"
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}
{
"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"
}

Volver

Usuarios

En esta página