Skip to main content
Kintone logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: KINTONE
  • Version: 20261101_00

Tools

Slug: KINTONE_CHANGE_LOGIN_CODESIrreversibly change the login codes of up to 100 Kintone users in one batch. Warning: this changes user identities and cannot be undone automatically.

Input Parameters

array
required
One to 100 login-code changes. Each current_code and new_code must be nonblank and unique within its respective set. Warning: accepted changes are irreversible and affect how users log in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_CREATE_DEPARTMENTSCreate 1 to 100 Kintone departments in one batch. Submit parent departments before their children when creating a hierarchy.

Input Parameters

array
required
One to 100 new departments in parent-before-child order. Every item requires a unique code and name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_CREATE_GROUPSCreate 1 to 100 static or dynamic Kintone groups in one batch. Each group requires a unique code, name, and membership type.

Input Parameters

array
required
One to 100 new groups, each with a unique code, name, and type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_CREATE_USERSCreate 1 to 100 Kintone tenant users in one batch with a login code, password, and display name for each user. Newly created users need separate service assignments to access Kintone services.

Input Parameters

array
required
One to 100 users to create. Every user requires code, password, and name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_DELETE_DIRECTORY_RESOURCESPermanently delete a non-empty batch of Kintone users, departments, or groups by exact code. Deleted resources cannot be recovered by this tool. Deleting a department may also delete all of its child departments and requires explicit cascade confirmation.

Input Parameters

array
required
One to 100 exact resource codes to permanently delete.
string ("user" | "department" | "group")
required
Type of directory resource to permanently delete. This selects one fixed Kintone endpoint and is not sent to the provider.
boolean
Must be explicitly true when resource_type is department. Deleting a department may also delete all of its child departments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_GET_USER_ACCESSGet one user’s department memberships, group memberships, and Kintone service assignment in one read.

Input Parameters

string
required
Exact user login code whose department, group, and service access to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_LIST_DIRECTORY_CONTAINERSList or filter Kintone departments or groups, one page at a time.

Input Parameters

array
Return only these container IDs, exactly as returned in each item’s id field. Mutually exclusive with codes; up to 100 IDs may be supplied.
integer
Maximum containers to return in this page (1-100).
array
Return only these exact container codes. Mutually exclusive with ids; up to 100 codes may be supplied.
string
Continuation cursor returned by a previous call; omit for the first page.
string ("department" | "group")
required
Directory container type to list: department or group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_LIST_MEMBERSList users belonging to a Kintone department or group, one page at a time.

Input Parameters

string
Exact department or group code. Required on the first page; omit when continuing with next_cursor.
integer
Maximum members to return in this page (1-100).
string
Continuation cursor returned by a previous call; omit for the first page.
string ("department" | "group")
Type of container whose members to list: department or group. Required on the first page; omit when continuing with next_cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_LIST_USERSList or filter tenant users by ID or login code, one page at a time.

Input Parameters

array
Return only these user IDs, exactly as returned in each user’s id field. Mutually exclusive with codes; up to 100 IDs may be specified.
integer
Maximum users in this page (1-100).
array
Return only these user login codes. Mutually exclusive with ids; up to 100 codes may be specified.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REPLACE_GROUP_USERSReplace a Kintone static group’s complete user membership list. The submitted list is a complete replacement: omitted existing users are removed, and an empty list removes all.

Input Parameters

string
required
Exact code of the static group to update.
array
required
Complete replacement list of user login codes for the static group. Existing users omitted from this list are removed; pass an empty list to remove every user from the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REPLACE_USER_DEPARTMENTSReplace the complete department membership lists for one to 100 Kintone users. Each submitted list is a complete replacement: omitted existing department memberships are removed, and an empty list removes all.

Input Parameters

array
required
One to 100 users and their complete replacement department lists. For each user, omitted existing department memberships are removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REPLACE_USER_GROUPSReplace a Kintone user’s complete static-group membership list. The submitted list is a complete replacement: omitted existing group memberships are removed, and an empty list removes all.

Input Parameters

string
required
Exact login code of the user to update.
array
required
Complete replacement list of static-group codes for the user. Existing group memberships omitted from this list are removed; pass an empty list to remove all static-group memberships.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_SET_SERVICE_ASSIGNMENTSReplace Kintone service access for one to 100 users. An empty services array disables access, so omitted existing assignments are removed.

Input Parameters

array
required
One to 100 unique users and their complete Kintone service assignments. Each services value must be [] or [‘kintone’].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_UPDATE_DEPARTMENTSUpdate mutable fields for 1 to 100 existing Kintone departments, identified by exact department code.

Input Parameters

array
required
One to 100 departments to update by exact code. Include only mutable fields that should change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_UPDATE_GROUPSUpdate the name and optional description of 1 to 100 existing Kintone groups, identified by exact group code. Group type cannot be changed.

Input Parameters

array
required
One to 100 groups to update by exact code. Every item requires its replacement name; group type cannot be changed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_UPDATE_USERSUpdate editable profile and primary-organization fields for 1 to 100 existing Kintone tenant users identified by login code.

Input Parameters

array
required
One to 100 existing users to update by required login code. Include only the editable fields to change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not