/ /

/ /

Obtener un usuario por nombre

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

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 tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para 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 tener la Project User Admin rol en al menos un proyecto que sea común entre usted y el usuario que está recuperando.

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://cloud.mongodb.com/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 del usuario de MongoDB que desea recuperar.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

envolvente

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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la 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 de Cloud Manager.

firstName

string

Nombre del usuario de Cloud Manager.

ID.

string

Identificador único del usuario de Cloud Manager.

lastName

string

Apellido del usuario Cloud Manager.

enlaces

matriz de objetos

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 Cloud Manager.

papeles

matriz de objetos

Asignación de roles.

roles.groupId

string

Identificador único del 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.nombreDeRol

string

Nombre del rol. El recurso users devuelve todos los roles que el usuario tiene en Cloud Manager y 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 Cloud Manager.

Ejemplo de solicitud

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"

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "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 identificación

Lista de acceso