> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Kintone

> Manage users, departments, groups, memberships, service assignments, and login codes in a Kintone tenant through the User API.

![Kintone logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/kintone.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=f4cce68592f140064faf75ee3d6a4f12)

* **Category:** human resources
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 16
* **Triggers:** 0
* **Slug:** `KINTONE`
* **Version:** 20261101\_00

## Tools

> [accordion] Change User Login Codes
>
> **Slug:** `KINTONE_CHANGE_LOGIN_CODES`
>
> Irreversibly 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
>
> **changes** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Departments
>
> **Slug:** `KINTONE_CREATE_DEPARTMENTS`
>
> Create 1 to 100 Kintone departments in one batch. Submit parent departments before their children when creating a hierarchy.
>
> #### Input Parameters
>
> **departments** `array` *required*
>
> One to 100 new departments in parent-before-child order. Every item requires a unique code and name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Groups
>
> **Slug:** `KINTONE_CREATE_GROUPS`
>
> Create 1 to 100 static or dynamic Kintone groups in one batch. Each group requires a unique code, name, and membership type.
>
> #### Input Parameters
>
> **groups** `array` *required*
>
> One to 100 new groups, each with a unique code, name, and type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Users
>
> **Slug:** `KINTONE_CREATE_USERS`
>
> Create 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
>
> **users** `array` *required*
>
> One to 100 users to create. Every user requires code, password, and name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Users, Departments, or Groups
>
> **Slug:** `KINTONE_DELETE_DIRECTORY_RESOURCES`
>
> Permanently 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
>
> **codes** `array` *required*
>
> One to 100 exact resource codes to permanently delete.
>
> **resource\_type** `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.
>
> **confirm\_department\_cascade** `boolean`
>
> Must be explicitly true when resource\_type is department. Deleting a department may also delete all of its child departments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Access
>
> **Slug:** `KINTONE_GET_USER_ACCESS`
>
> Get one user's department memberships, group memberships, and Kintone service assignment in one read.
>
> #### Input Parameters
>
> **user\_code** `string` *required*
>
> Exact user login code whose department, group, and service access to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Departments or Groups
>
> **Slug:** `KINTONE_LIST_DIRECTORY_CONTAINERS`
>
> List or filter Kintone departments or groups, one page at a time.
>
> #### Input Parameters
>
> **ids** `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.
>
> **size** `integer`
>
> Maximum containers to return in this page (1-100).
>
> **codes** `array`
>
> Return only these exact container codes. Mutually exclusive with ids; up to 100 codes may be supplied.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **resource\_type** `string ("department" | "group")` *required*
>
> Directory container type to list: department or group.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Department or Group Members
>
> **Slug:** `KINTONE_LIST_MEMBERS`
>
> List users belonging to a Kintone department or group, one page at a time.
>
> #### Input Parameters
>
> **code** `string`
>
> Exact department or group code. Required on the first page; omit when continuing with next\_cursor.
>
> **size** `integer`
>
> Maximum members to return in this page (1-100).
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> **container\_type** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `KINTONE_LIST_USERS`
>
> List or filter tenant users by ID or login code, one page at a time.
>
> #### Input Parameters
>
> **ids** `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.
>
> **size** `integer`
>
> Maximum users in this page (1-100).
>
> **codes** `array`
>
> Return only these user login codes. Mutually exclusive with ids; up to 100 codes may be specified.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace Group Users
>
> **Slug:** `KINTONE_REPLACE_GROUP_USERS`
>
> Replace 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
>
> **group\_code** `string` *required*
>
> Exact code of the static group to update.
>
> **user\_codes** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace User Departments
>
> **Slug:** `KINTONE_REPLACE_USER_DEPARTMENTS`
>
> Replace 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
>
> **user\_departments** `array` *required*
>
> One to 100 users and their complete replacement department lists. For each user, omitted existing department memberships are removed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace User Groups
>
> **Slug:** `KINTONE_REPLACE_USER_GROUPS`
>
> Replace 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
>
> **user\_code** `string` *required*
>
> Exact login code of the user to update.
>
> **group\_codes** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set User Service Assignments
>
> **Slug:** `KINTONE_SET_SERVICE_ASSIGNMENTS`
>
> Replace Kintone service access for one to 100 users. An empty services array disables access, so omitted existing assignments are removed.
>
> #### Input Parameters
>
> **users** `array` *required*
>
> One to 100 unique users and their complete Kintone service assignments. Each services value must be \[] or \['kintone'].
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Departments
>
> **Slug:** `KINTONE_UPDATE_DEPARTMENTS`
>
> Update mutable fields for 1 to 100 existing Kintone departments, identified by exact department code.
>
> #### Input Parameters
>
> **departments** `array` *required*
>
> One to 100 departments to update by exact code. Include only mutable fields that should change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Groups
>
> **Slug:** `KINTONE_UPDATE_GROUPS`
>
> Update the name and optional description of 1 to 100 existing Kintone groups, identified by exact group code. Group type cannot be changed.
>
> #### Input Parameters
>
> **groups** `array` *required*
>
> One to 100 groups to update by exact code. Every item requires its replacement name; group type cannot be changed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Users
>
> **Slug:** `KINTONE_UPDATE_USERS`
>
> Update editable profile and primary-organization fields for 1 to 100 existing Kintone tenant users identified by login code.
>
> #### Input Parameters
>
> **users** `array` *required*
>
> One to 100 existing users to update by required login code. Include only the editable fields to change.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
