Docs Home

/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Organizaciones y equipos

Organizaciones

Obtener todos los usuarios de la organización

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

Sintaxis

GET /orgs/{ORG-ID}/users

Parámetros de la ruta de solicitud

Parameter	Obligatorio/Opcional	Descripción
`ORG-ID`	Requerido.	El identificador único de Organización cuyos datos de usuario deseas recuperar.

Parámetros de Solicitud Query

Campo	Obligatorio/Opcional	Descripción
`pageNum`	Opcional.	La página a la que volver. Se establece por defecto en `1`.
`itemsPerPage`	Opcional.	Número de elementos a devolver por página, hasta un máximo de 500. Se establece por defecto en `100`.
`envelope`	Opcional.	Un booleano que especifica si se debe envolver o no la respuesta en un envoltorio. Se establece por defecto en `false`.
`pretty`	Opcional	Un booleano que especifica si se debe devolver o no un documento JSON "formateado". 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 retorna un documento JSON que incluye los siguientes objetos:

`results`

Un arreglo de documentos, cada uno representando 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

La ID del usuario.

links

Uno o más enlaces a sub-recursos 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 de Rol en 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`

Un arreglo de documentos que representa un enlace a uno o más subrecursos y/o recursos relacionados, como la paginación de la lista. Consulta Vinculación para obtener más información.

`totalCount`

El número total de elementos en el conjunto de resultados. Este valor puede ser superior al número de objetos en el arreglo results si todo el conjunto de resultados está paginado.

Solicitud de ejemplo

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