Campo	Obligatorio/Opcional	Descripción
`pageNum`	Opcional.	La página a la que regresar. Se establece por defecto en `1`.
`itemsPerPage`	Opcional.	Número de artículos a devolver por página, hasta un máximo de 500. Se establece por defecto en `100`.
`envelope`	Opcional.	Un valor booleano que especifica si se debe o no envolver la respuesta en un sobre. Se establece por defecto en `false`.
`pretty`	Opcional	Un valor booleano que especifica si se debe devolver o no un documento JSON "impreso de forma bonita". Se establece por defecto en `false`.

Elementos de respuesta

Si establece el elemento de consulta envelope en true, la respuesta estará envuelta por el objeto content.

La respuesta HTTP devuelve un documento JSON que incluye los siguientes objetos:

`results`

Una serie de documentos, cada uno de los cuales representa a un usuario de la organización.

Nombre

Descripción

country

El país donde vive el usuario.

emailAddress

La dirección de correo electrónico del usuario.

firstName

El nombre del usuario.

lastName

ID del proyecto de Ops Manager al que pertenece el usuario.

id

El id del usuario.

links

Uno o más enlaces a subrecursos y/o recursos relacionados.

mobileNumber

El número de teléfono móvil del usuario.

username

El nombre de usuario para autenticarse en MongoDB.

roles

Una matriz de los roles del usuario dentro de la organización y para cada proyecto al que pertenece el usuario.

roles.{ENTITY-ID}

El {ENTITY-ID} representa la organización o el proyecto al que se aplica este rol. Los valores posibles son: orgId o groupId.

roles.roleName

El nombre del rol. El recurso users devuelve todos los roles que el usuario tiene en Ops Manager o MongoDB Atlas. Los valores posibles son:

Roles de la organización
Valor del rol en la API
rol
ORG_OWNER
Organization Owner
ORG_MEMBER
Organization Member
ORG_GROUP_CREATOR
Organization Project Creator
ORG_READ_ONLY
Organization Read Only
Roles del proyecto
Grupos y proyectos son términos sinónimos.
- GROUP_OWNER
- GROUP_READ_ONLY
- GROUP_DATA_ACCESS_ADMIN
- GROUP_DATA_ACCESS_READ_WRITE
- GROUP_DATA_ACCESS_READ_ONLY
- GROUP_AUTOMATION_ADMIN
- GROUP_BACKUP_ADMIN
- GROUP_MONITORING_ADMIN
- GROUP_OWNER
- GROUP_USER_ADMIN

teamIds

Una matriz de identificadores de equipo para la organización.

`links`

Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información.

`totalCount`

Número total de elementos en el conjunto de resultados. Este valor puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

Ejemplo de solicitud

Solicitud

curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"

Respuesta

{
  "links" : [ ... ],
  "results" : [
    {
       "country": "US",
       "emailAddress": "someone@example.com",
       "firstName": "John",
       "id": "59db8d1d87d9d6420df0613a",
       "lastName": "Smith",
       "links": [ ... ],
       "mobileNumber": "123-456-7890",
       "roles": [{
         "groupId": "59ea02e087d9d636b587a967",
         "roleName": "GROUP_OWNER"
       }, {
         "groupId": "59db8d1d87d9d6420df70902",
         "roleName": "GROUP_OWNER"
       }, {
         "orgId": "59db8d1d87d9d6420df0613f",
         "roleName": "ORG_OWNER"
       }],
       "teamIds" : [ "5aeeed020bd6ef9d00033291", "5ac2aeadcabceef96172be31" ],
       "username": "someone@example.com"
    },
    ...
  ],
  "totalCount" : 2
}

Volver

Obtener todos los proyectos

Crear organización