Documentos de API

Actualizar miembros del espacio

Actualiza los miembros de un espacio.

MétodoPUT
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

Contenido

Permisos

  • Solo los administradores de espacio pueden usar esta API.

Parámetros de solicitud

Parámetro Valor Obligatorio Descripción
id Entero o cadena Sí El ID del espacio.
members Arreglo Sí Una lista de los miembros del Espacio.
Se debe especificar al menos un administrador de espacio.
No se pueden especificar los usuarios inactivos y eliminados.
members[].entity Objeto Sí La información de la entidad del miembro Space.
No se pueden especificar usuarios invitados.
members[].entity.type Cuerda Sí Tipo de entidad del miembro Space.
  • USER: Usuario
  • Group: Grupo
  • ORGANIZATION: Departamento
members[].entity.code Cuerda Sí El código de la entidad.
members[].isAdmin Booleano o cadena Condicional La configuración de Administración de espacio del usuario.
  • true: El miembro será el Administrador del Espacio.
  • false: El miembro no será el Administrador del Espacio.
    Se requiere que se establezca al menos 1 administrador de espacio en la llamada a la API.
Si se omite, este valor es falso.
members[].includeSubs Booleano o cadena La configuración "Incluir departamentos afiliados" del departamento.
  • true: Se incluirán los departamentos adscritos.
  • false: No se incluirán los departamentos afiliados.
Si se omite, este valor es falso.

Solicitud de muestra

JavaScript using kintone.api() 

 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

var body = {
  'id': '1001',
  'members': [
    {
      'entity': {
        'type': 'USER',
        'code': 'user1'
      },
      'isAdmin': true
    },
    {
      'entity': {
        'type': 'GROUP',
        'code': 'group1'
      },
      'isAdmin': false
    },
    {
      'entity': {
        'type': 'ORGANIZATION',
        'code': 'org1'
      },
      'isAdmin': false,
      'includeSubs': true
    }
  ]
};

kintone.api(kintone.api.url('/k/v1/space/members.json', true), 'PUT', 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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

var body = {
  'id': '1001',
  'members': [
    {
      'entity': {
        'type': 'USER',
        'code': 'user1'
      },
      'isAdmin': true
    },
    {
      'entity': {
        'type': 'GROUP',
        'code': 'group1'
      },
      'isAdmin': false
    },
    {
      'entity': {
        'type': 'ORGANIZATION',
        'code': 'org1'
      },
      'isAdmin': false,
      'includeSubs': true
    }
  ],
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.kintone.com/k/v1/space/members.json';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(JSON.stringify(body));

Parámetros de respuesta

Se devolverá un objeto JSON vacío.

Ejemplo de respuesta 

1

{}

Limitaciones

  • Si la función Espacio o Espacio de invitado está desactivada, se devolverá un error.
  • Esta API no puede actualizar los miembros invitados de los espacios de invitado. Para ello, utilice la siguiente API:
    Actualizar a los miembros invitados