Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Obten a un usuario por nombre

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, su ID del grupo sigue siendo el mismo. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El punto final permanece como se indica en el documento.

Siempre puedes recuperar tu cuenta de usuario. De lo contrario, usted debe tener el rol de Project User Admin en al menos un proyecto que sea común entre usted y el usuario que está 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

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

NOMBRE DE USUARIO

string

(Obligatorio.) Nombre de usuario de MongoDB que deseas recuperar.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que muestra si se debe devolver el cuerpo de la respuesta en un prettyprint formato.

false

envelope

booleano

Opcional

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

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

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

  • 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

Correo electrónico del usuario de Cloud Manager.

Nombre

string

Primer nombre del usuario de Cloud Manager.

ID

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:

Nombre de usuario

string

Nombre de usuario del usuario del Cloud Manager.

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"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "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"}