/ /

Gerente de Operaciones

Obtener un usuario por nombre

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene 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 puede usar este punto de conexión para devolver información sobre una clave API. Solicite el punto de conexión "Obtener una clave API" para obtener esta información.

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

Resource

GET /users/byName/{USER-NAME}

Parámetros de la ruta de solicitud

Parameter	Tipo	Descripción
NOMBRE DE USUARIO	string	(Obligatorio.) Nombre de usuario de MongoDB que deseas recuperar.

Parámetros de Solicitud Query

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 de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

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

Parámetros del cuerpo de la solicitud

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

Respuesta

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

firstName

string

Primer nombre del usuario de Ops Manager.

string

Identificador único del usuario de Ops Manager.

lastName

string

Apellido del usuario de Ops Manager.

enlaces

objeto arreglo

Enlaces a subrecursos relacionados. Todas las links matrices en las respuestas incluyen al menos un enlace llamado "self". La relación entre las URL se explica en la Especificación de Enlaces 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.nombreDeRol

string

Nombre del rol. Los valores son:

Valor	Descripción
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Nombre de usuario

string

Nombre de usuario del usuario de Ops Manager.

Solicitud de ejemplo

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"

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

{
  "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"
}

Volver

Obtener por ID

Crear