Agregar usuarios

Agrega usuarios a un entorno de Kintone.
Tenga en cuenta que una vez que se agrega un usuario con esta API, la API de actualización de servicios de usuario debe usarse contra este usuario para que el usuario tenga acceso a los servicios de Kintone.

Para obtener más información sobre la API de actualización de servicios de usuario, consulte el siguiente artículo:
Actualizar los servicios de usuario

MétodoPOST
URLhttps://{subdomain}.kintone.com/v1/users.json
Autenticación Autenticación de contraseña, Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

Solo los administradores pueden usar esta API.

Para obtener más información sobre los administradores, consulte el siguiente artículo:
Tipos de administradores (External link)

Parámetros de solicitud

En la solicitud se debe especificar una matriz "users" que consiste en un objeto formado por las siguientes propiedades. Se pueden actualizar hasta 100 usuarios.

Parámetro Valor Obligatorio Descripción
code Cuerda El código de usuario (nombre de inicio de sesión).
El límite máximo es de 128 caracteres.
No se permiten valores que consten solo de espacios en blanco o nulos.
valid Booleano Opcional El estado del usuario. El valor predeterminado es true.
Estado true para usuarios activos, y false para usuarios inactivos.
password Cuerda La contraseña.
El límite máximo es de 128 caracteres.
No se permiten espacios en blanco.
name Cuerda El nombre para mostrar.
El límite máximo es de 128 caracteres.
No se permiten valores que consten solo de espacios en blanco o nulos.
surName Cuerda Opcional El apellido.
El límite máximo es de 128 caracteres.
givenName Cuerda Opcional El nombre de pila.
El límite máximo es de 128 caracteres.
surNameReading Cuerda Opcional El apellido fonético.
El límite máximo es de 128 caracteres.
Esta configuración no se muestra al editar la información del usuario en la página "Departamentos y usuarios" para kintone.com dominios.
givenNameReading Cuerda Opcional El nombre de pila fonético.
El límite máximo es de 128 caracteres.
Esta configuración no se muestra al editar la información del usuario en la página "Departamentos y usuarios" para kintone.com dominios.
localName Cuerda Opcional El nombre localizado.
El límite máximo es de 128 caracteres.
Esta configuración no se muestra al editar la información del usuario en la página "Departamentos y usuarios" para kintone.com dominios.
localNameLocale Cuerda Opcional El idioma del nombre localizado.
El límite máximo es de 128 caracteres.
Esta configuración no se muestra al editar la información del usuario en la página "Departamentos y usuarios" para kintone.com dominios.
timezone Cuerda Opcional La zona horaria del usuario.
Se producirá un error si se deja en blanco.
El límite máximo es de 256 caracteres.
locale Cuerda Opcional La configuración de idioma.
Especifique una de las siguientes opciones: en, ja, zh, eso auto.
Si se establece como auto o si se deja en blanco, la configuración de idioma del usuario se establecerá en "Usar la configuración del navegador web".
description Cuerda Opcional La descripción del usuario, que se muestra en la sección "Acerca de mí" del perfil.
El límite máximo es de 1000 caracteres.
phone Cuerda Opcional El número de teléfono.
El límite máximo es de 100 caracteres.
mobilePhone Cuerda Opcional El número de teléfono móvil.
El límite máximo es de 100 caracteres.
extensionNumber Cuerda Opcional El número de extensión.
El límite máximo es de 100 caracteres.
email Cuerda Opcional La dirección de correo electrónico.
El límite máximo es de 256 caracteres.
callto Cuerda Opcional El nombre de Skype.
Las limitaciones se basan en las limitaciones de los nombres de Skype.
url Cuerda Opcional URL
El límite máximo es de 256 caracteres.
employeeNumber Cuerda Opcional El ID de empleado.
El límite máximo es de 100 caracteres.
birthDate Fecha Opcional El cumpleaños.
Especifique la fecha en el formato "AAAA-MM-DD" o una cadena vacía.
joinDate Fecha Opcional La fecha de contratación.
Especifique la fecha en el formato "AAAA-MM-DD" o una cadena vacía.
sortOrder Número Opcional La prioridad del usuario en las listas de usuarios. Los usuarios se ordenan en la lista en orden ascendente en función de este número.
Se pueden utilizar números del 0 al 99999999.
customItemValues Matrices customItemValue Opcional Una lista de pares de códigos de artículos personalizados y valores de artículos personalizados para campos personalizados.

Solicitud de muestra

 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
var body = {
  'users': [
    {
      'code': 'Administrator',
      'valid': true,
      'password': 'xxxyyyzzz',
      'name': 'Administrator',
      'surName': 'a',
      'givenName': '',
      'surNameReading': '',
      'givenNameReading': '',
      'localName': '',
      'localNameLocale': 'en',
      'timezone': 'America/Los_Angeles',
      'locale': 'en',
      'description': '',
      'phone': '',
      'mobilePhone': '',
      'extensionNumber': '',
      'email': '',
      'callto': '',
      'url': '',
      'employeeNumber': '123',
      'birthDate': '1980-01-01',
      'joinDate': '2015-04-01',
      'sortOrder': 12,
      'customItemValues': [
        {
          'code': 'userNameKey',
          'value': 'jf'
        }
      ]
    }
  ]
};
kintone.api(kintone.api.url('/v1/users.json', true), 'POST', 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
46
47
48
49
50
51
52
53
var body = {
  'users': [
    {
      'code': 'Administrator',
      'valid': true,
      'password': 'xxxyyyzzz',
      'name': 'Administrator',
      'surName': 'a',
      'givenName': '',
      'surNameReading': '',
      'givenNameReading': '',
      'localName': '',
      'localNameLocale': 'en',
      'timezone': 'America/Los_Angeles',
      'locale': 'en',
      'description': '',
      'phone': '',
      'mobilePhone': '',
      'extensionNumber': '',
      'email': '',
      'callto': '',
      'url': '',
      'employeeNumber': '123',
      'birthDate': '1980-01-01',
      'joinDate': '2015-04-01',
      'sortOrder': 12,
      'customItemValues': [
        {
          'code': 'userNameKey',
          'value': 'jf'
        }
      ]
    }
  ],
  // CSRF TOKEN: Needs to be set when using API (POST, PUT, DELETE) from Kintone
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.kintone.com/v1/users.json';
var xhr = new XMLHttpRequest();
xhr.open('POST', 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

  • No se recomienda ejecutar esta API mientras se realizan las siguientes operaciones en el Administración de usuarios y sistemas página:
    • Actualizaciones para los usuarios en el Departamentos y Usuarios página
      Para obtener más información sobre Departamentos y usuarios, consulte el siguiente artículo:
      Gestión de usuarios (External link)
    • Importar desde un archivo