Obtener usuarios

Documentos de API

Obtener usuarios

Obtiene información de los usuarios.

Método	GET
URL	https://{subdomain}.kintone.com/v1/users.json
Autenticación	Autenticación mediante token API , Autenticación mediante contraseña , Autenticación mediante sesión
Content-Type	application/json (no es necesario si se especifica la consulta con una cadena de consulta)

Permisos

Todos los usuarios que no sean usuarios invitados pueden usar esta API.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción
ids	Arreglo	Opcional	Una lista de ID de usuario, como tipos de ID. Se pueden especificar hasta 100 identificadores. Para obtener más información sobre los tipos de identificación, consulte el siguiente enlace: Tipo de ID
codes	Arreglo	Opcional	Una lista de códigos de usuario (nombres de inicio de sesión), como cadenas. Se pueden especificar hasta 100 códigos.
offset	Integer	Opcional	La compensación. Si se omite, este valor es 0.
size	Integer	Opcional	El número máximo de información del usuario que se va a obtener. Si se omite, este valor es 100.

*Si ids y codes si ambos se ignoran, se responderán hasta 100 identificaciones en orden ascendente.
Si ids y codes si ambos están activados, devolverá un error. Solo se puede configurar uno.

Solicitud de muestra

JavaScript using kintone.api()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


var body = {
  'ids': [1, 2, 3],
  'offset': 0,
  'size': 100
};
kintone.api(kintone.api.url('/v1/users.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
16


var params = '?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100';
var url = 'https://{subdomain}.kintone.com/v1/users.json' + params;
console.log(url);
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
users	Array	Una lista de información de usuario, como tipos de usuario. Para obtener más información sobre los tipos de usuarios, consulte el siguiente enlace: Tipo de usuario

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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80


{
  "users": [
    {
      "birthDate": "2011-05-01",
      "callto": "",
      "code": "a",
      "ctime": "2013-07-22T08:12:18Z",
      "customItemValues": [
        {
          "code": "item1",
          "value": "aitem1"
        },
        {
          "code": "secret",
          "value": "aitem2"
        }
      ],
      "description": "",
      "email": "",
      "employeeNumber": "",
      "extensionNumber": "",
      "givenName": "",
      "givenNameReading": "",
      "id": "1",
      "joinDate": "2013-01-01",
      "localName": "",
      "localNameLocale": "en",
      "locale": "",
      "mobilePhone": "",
      "mtime": "2013-07-22T09:00:00Z",
      "name": "a",
      "phone": "",
      "primaryOrganization": null,
      "sortOrder": 2147483647,
      "surName": "a",
      "surNameReading": "",
      "timezone": "America/Los_Angeles",
      "url": "",
      "valid": true
    },
    {
      "birthDate": null,
      "callto": "",
      "code": "Administrator",
      "ctime": "2013-07-19T08:16:00Z",
      "customItemValues": [
        {
          "code": "item1",
          "value": "adminitem1"
        },
        {
          "code": "secret",
          "value": "adminitem2"
        }
      ],
      "description": "",
      "email": "",
      "employeeNumber": "",
      "extensionNumber": "",
      "givenName": "",
      "givenNameReading": "",
      "id": "7532782697181632512",
      "joinDate": null,
      "localName": "",
      "localNameLocale": "en",
      "locale": "",
      "mobilePhone": "",
      "mtime": "2013-07-22T08:13:00Z",
      "name": "Administrator",
      "phone": "",
      "primaryOrganization": null,
      "sortOrder": 2147483647,
      "surName": "",
      "surNameReading": "",
      "timezone": "America/Los_Angeles",
      "url": "",
      "valid": true
    }
  ]
}

Notas

Valores personalizados de campo de usuario (customItemValues) solo se pueden recuperar después de que el perfil de cada usuario individual haya sido actualizado al menos una vez en la interfaz de Kintone. Si el perfil del usuario nunca se ha actualizado, la API devolverá un vacío customItemValues Array, incluso si hay campos personalizados configurados.