Join the program

Add Users

Last Updated:
Follow
Adds users to a kintone environment.
Note that once a user is added with this API, the Update User Services API needs to be used against this user for the user to have access to kintone services.
Method POST
URL https://{subdomain}.kintone.com/v1/users.json
Authentication Password Authentication
Content-Type application/json

Permissions

Only Administrators can use this API.

Request Parameters

A "users" array consisting of an object formed by the below properties is to be specified in the request. Services of up to 100 users can be updated.

Parameter Value Required Description
code String Yes

The User Code (log-in name).

The maximum limit is 128 characters.
Values consisting of only whitespaces or null are not allowed.
valid Boolean  Optional The Status of the user. The default is true.
State true for active users, and false for inactive users.
password String Yes

The password.

The maximum limit is 128 characters.
Whitespaces are not allowed.
name String Yes

The display name.

The maximum limit is 128 characters.
Values consisting of only whitespaces or null are not allowed.
surName String Optional 

The Surname.

The maximum limit is 128 characters.
givenName String  Optional

The Given Name.

The maximum limit is 128 characters.
surNameReading String Optional 

The Phonetic Surname.

The maximum limit is 128 characters.

This setting is not displayed when editing user information on the "Departments & Users" page for kintone.com domains.
givenNameReading String Optional 

The Phonetic Given Name.

The maximum limit is 128 characters.

This setting is not displayed when editing user information on the "Departments & Users" page for kintone.com domains.
localName String  Optional

The Localizled Name.

The maximum limit is 128 characters.

This setting is not displayed when editing user information on the "Departments & Users" page for kintone.com domains.
localNameLocale String Optional 

The Language for the Localized Name.

The maximum limit is 128 characters.

This setting is not displayed when editing user information on the "Departments & Users" page for kintone.com domains.
timezone String  Optional

The user's timezone.
An error will occur if left blank.

The maximum limit is 256 characters.
locale String  Optional

The language settings.

The maximum limit is 256 characters.
description String  Optional

The description of the user, displayed on the "About me" section of the profile.

The maximum limit is 1000 characters.
phone String  Optional 

The Phone number.

The maximum limit is 100 characters.
mobilePhone String  Optional 

The Mobile phone number.

The maximum limit is 100 characters.
extensionNumber String  Optional

The Extension number.

The maximum limit is 100 characters.
email String  Optional 

The E-mail address.

The maximum limit is 256 characters.
callto String  Optional 

The Skype name.

Limitations are based on limitations of Skype names.
url String  Optional

URL

The maximum limit is 256 characters.
employeeNumber String  Optional

The Employee ID.

The maximum limit is 100 characters.
birthDate Date  Optional The Birthday.
joinDate Date  Optional The Hire Date.
sortOrder Number  Optional 

The priority of the user in lists of users. Users are sorted in the list in ascending order based on this number.

Numbers from 0 to 99999999 can be used.
customItemValues customItemValue Arrays  Optional A list of pairs of Custom Item codes and Custom Item values for Custom Fields.

Sample Request

JavaScript (using kintone REST API Request)

XMLHttpRequest

Response Parameters

An empty JSON object will be returned.

Sample Response

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!