/ /

/ /

Obten a un usuario por nombre

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Nota

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

Siempre puedes recuperar tu cuenta de usuario. De lo contrario, debes tener el Project User Admin rol en al menos un proyecto que sea común entre ti y el usuario que estás recuperando.

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://cloud.mongodb.com/api/public/v1.0

Resource

GET /users/byName/{USER-NAME}

Parámetros de 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 respuesta debe estar en un prettyprint 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

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

Correo electrónico del usuario de Cloud Manager.

Nombre

string

Primer nombre del usuario de Cloud Manager.

string

Identificador único del usuario de Cloud Manager.

Apellidos

string

Apellido del usuario de Cloud 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 teléfono móvil del usuario de Cloud Manager.

Roles

objeto arreglo

Asignaciones de roles.

roles.groupId

string

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

roles.orgId

string

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

roles.roleName

string

Nombre del rol. El recurso users devuelve todos los roles que el usuario tiene tanto en Cloud Manager como en MongoDB Atlas.

Los siguientes valores son válidos:

Valor	Descripción
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_BILLING_ADMIN`	`Organization Billing Admin`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_ATLAS_ADMIN`	`Project Admin (Atlas)`
`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`

Nombre de usuario

string

Nombre de usuario del usuario del Cloud Manager.

Solicitud de ejemplo

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"

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

Lista de acceso