Obtener miembros del espacio

Obtiene la lista de miembros de espacio de un espacio.

MétodoGET
URLhttps://{subdomain}.kintone.com/k/v1/space/members.json
URL (espacio de invitado)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/space/members.json
Autenticación Autenticación de contraseña, Autenticación de sesión
Content-Typeapplication/json (no es necesario si se especifica la consulta con una cadena de consulta)

Contenido

Permisos

En el caso de los Espacios Privados, el usuario debe ser miembro del Espacio.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
id Entero o cadena El ID del espacio.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var body = {
  'id': 1
};

kintone.api(kintone.api.url('/k/v1/space/members.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
var url = 'https://{subdomain}.kintone.com/k/v1/space/members.json?id=1';

var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Parámetros de respuesta

Parámetro Tipo Descripción
members Arreglo Una lista de los miembros de Space.
No se incluirán los usuarios invitados, los usuarios inactivos y los usuarios eliminados.
members[].entity Objeto La información de la entidad del miembro Space.
members[].entity.type Cuerda Tipo de entidad del miembro Space.

USER: Usuario
GROUP: Grupo
ORGANIZATION: Departamento
members[].entity.code Cuerda El código del miembro Space.
members[].isAdmin Booleano La configuración de Space Admin del miembro Space

true: El miembro del espacio es el administrador del espacio.
false: El miembro del espacio no es el administrador del espacio.
members[].isImplicit Booleano Si el miembro del espacio se agrega como usuario o no.

true: El miembro del espacio no se agrega como usuario y se agrega como parte de un grupo o departamento.
false: El miembro del espacio se agrega como usuario.

Esto no se responde para GRUPO y ORGANIZACIÓN Entidades.
members[].includeSubs Booleano El "Incluir departamentos afiliados" del Miembro del Departamento de Espacio.

true: Se incluyen los Departamentos Afiliados.
false: Los departamentos afiliados no están incluidos.

Ejemplo de respuesta

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "members": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "isAdmin": false,
      "isImplicit": true
    },
    {
      "entity": {
        "type": "USER",
        "code": "user2"
      },
      "isAdmin": true,
      "isImplicit": false
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "isAdmin": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "isAdmin": false,
      "includeSubs": true
    }
  ]
}

Limitaciones

  • Si la función Espacio o Espacio de invitado está desactivada, se devolverá un error.
  • El uso de esta API en los espacios de invitado solo devolverá usuarios de espacios que no sean invitados.