La API de usuario es una API REST que obtiene, agrega y actualiza información de usuario/grupo/departamento.

La API de REST de usuario requiere autenticación de contraseña, con las claves y los valores adecuados establecidos en el encabezado de la solicitud. Si la función de seguridad de autenticación básica también está configurada en su dominio, se requerirán tanto encabezados para la autenticación de contraseña como para la autenticación básica para la solicitud.

Establezca "X-Cybozu-Authorization" en el encabezado de la solicitud, con un nombre de inicio de sesión y una contraseña codificados en BASE64 como valor.
Si su nombre de inicio de sesión es Tono de kintone" y su contraseña es "developer", codificación BASE64 "Kintone:developer" y configúrelo en el encabezado de la siguiente manera:

1

X-Cybozu-Authorization: S2ludG9uZTpkZXZlbG9wZXI=

La autenticación de sesión es un método de autenticación en el que el servidor web asigna un ID de sesión a un usuario y lo guarda como una cookie. Esta cookie se utiliza para identificar y autenticar al usuario. La autenticación de sesión solo puede ser utilizada por códigos JavaScript que se ejecutan en las páginas de Kintone. Los tokens CSRF son necesarios cuando se utiliza la autenticación de sesión con métodos POST/PUT/DELETE. Consulte la siguiente documentación para obtener más detalles sobre la recuperación de un token CSRF:
Get CSRF Token

La prioridad de la autenticación es la siguiente.

1. Autenticación con contraseña
2. Autenticación de sesión

Advertencia

A partir de junio de 2020, la autenticación básica ha quedado obsoleta y ya no está disponible para su uso.

Si su entorno Kintone ha establecido la función de seguridad de autenticación básica, agregue "Autorización" en el encabezado de la solicitud, con la cadena "Basic" y un nombre de inicio de sesión y contraseña codificados en BASE64 de la autenticación básica como valor.
Si el nombre de inicio de sesión de autenticación básica es "chocolate" y la contraseña de autenticación básica es "pudding", lugar "Basic " en el valor, seguido de un BASE64 codificado "Chocolate:pudín" de la siguiente manera:

1

Authorization: Basic Y2hvY29sYXRlOnB1ZGRpbmc=

Estos encabezados de solicitud se utilizan para la API de REST.

El código de estado HTTP 200 indica que la solicitud se realizó correctamente.
Trate cualquier otro código de estado como errores. Los errores responderán con datos JSON, incluida la siguiente información.

1
2
3
4
5

{
  "message": "Invalid JSON string.",
  "id": "1505999166-897850006",
  "code": "CB_IJ01"
}

Se utiliza para entidades (usuario/grupo/departamentos) en Kintone.
Un número entero entre 1 y Long.MAX.

Llave	Tipo	Detalles
id	Tipo de ID	El ID de usuario. Consulte la siguiente sección para obtener más información sobre los tipos de identificación: Tipo de ID
code	Cuerda	El nombre de inicio de sesión del Usuario.
ctime	Formato de fecha y hora ISO-8601	La fecha y hora creada por el Usuario.
mtime	Formato de fecha y hora ISO-8601	La fecha y hora actualizada del Usuario.
valid	Booleano	Si el estado del usuario es Activo o no.
name	Cuerda	El nombre para mostrar del usuario.
surName	Cuerda	El apellido del Usuario.
givenName	Cuerda	El nombre del Usuario.
surNameReading	Cuerda	La lectura fonética del apellido.
givenNameReading	Cuerda	La lectura fonética del Nombre.
localName	Cuerda	El nombre para mostrar localizado del usuario.
localNameLocale	Cuerda	La configuración regional del nombre para mostrar localizado del usuario.
timezone	Cuerda	El identificador de zona horaria de la zona horaria establecida por el usuario. Vea toda la lista de zonas horarias en la Ayuda de Kintone: Lista de zonas horarias
locale	Cuerda	La configuración de idioma del usuario.
description	Cuerda	La sección "Acerca de mí" del perfil del usuario.
phone	Cuerda	El número de teléfono del Usuario.
mobilePhone	Cuerda	El número de teléfono móvil del Usuario.
extensionNumber	Cuerda	El número de extensión del Usuario.
email	Cuerda	La dirección de correo electrónico del Usuario.
callto	Cuerda	El ID de Skype del usuario.
url	Cuerda	La sección "URL" del perfil del usuario.
employeeNumber	Cuerda	El número de empleado del usuario.
birthDate	ISO-8601 formato de fecha o nulo	El cumpleaños del usuario.
joinDate	ISO-8601 formato de fecha o nulo	La fecha de contratación del usuario.
primaryOrganization	Entero o nulo	El ID de departamento del departamento prioritario del usuario. Establézcalo en null si no hay ningún departamento prioritario.
sortOrder	Integer	La prioridad del orden de visualización del usuario.
customItemValues	Matrices customItemValue	Una lista de pares de nombres de campos personalizados y códigos de campos personalizados. Consulte la siguiente sección para obtener más información sobre customItemValues: customItemValue type

Solo los usuarios y administradores del sistema pueden obtener datos de campos personalizados que tienen la opción "Visibilidad" desmarcada.
Para obtener más información sobre usuarios y administradores de sistemas, consulte el siguiente enlace:
Tipos de administradores

Es posible que los campos personalizados tengan la configuración "Hacer público este campo" de la opción "Visibilidad" sin marcar. Solo los usuarios y administradores del sistema pueden obtener datos de campos personalizados que tienen la opción "Visibilidad" desmarcada.
Para obtener más información sobre usuarios y administradores de sistemas, consulte el siguiente enlace:
Tipos de administradores

• Agregue el encabezado X-HTTP-Method-Override para evitar el error URI de solicitud demasiado grande que se produce cuando el URI de solicitud supera los 4 KB. Todas las API de usuario admiten este encabezado.
• Si se envía una solicitud GET de una API de usuario mediante el método de solicitud de API REST de Kintone y la longitud del URI supera los 4 KB, el encabezado X-HTTP-Method-Override se agregará automáticamente y la solicitud se enviará como una solicitud POST. Esto permite que las solicitudes de API de usuario con URI largos se ejecuten sin errores.
  Para obtener más información sobre el método de solicitud de API REST de Kintone, consulte el siguiente enlace:
  Solicitud de API REST de Kintone