---
canonical_url: "https://docs.composio.dev/toolkits/kintone"
markdown_url: "https://docs.composio.dev/toolkits/kintone.md"
product: "platform"
version: null
last_updated: null
---

# Kintone

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

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

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `departments` | array | Yes | One to 100 new departments in parent-before-child order. Every item requires a unique code and name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groups` | array | Yes | One to 100 new groups, each with a unique code, name, and type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | One to 100 users to create. Every user requires code, password, and name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_code` | string | Yes | Exact user login code whose department, group, and service access to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Departments or Groups

**Slug:** `KINTONE_LIST_DIRECTORY_CONTAINERS`

List or filter Kintone departments or groups, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | 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 | No | Maximum containers to return in this page (1-100). |
| `codes` | array | No | Return only these exact container codes. Mutually exclusive with ids; up to 100 codes may be supplied. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `resource_type` | string ("department" | "group") | Yes | Directory container type to list: department or group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `KINTONE_LIST_USERS`

List or filter tenant users by ID or login code, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | 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 | No | Maximum users in this page (1-100). |
| `codes` | array | No | Return only these user login codes. Mutually exclusive with ids; up to 100 codes may be specified. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_code` | string | Yes | Exact code of the static group to update. |
| `user_codes` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_departments` | array | Yes | One to 100 users and their complete replacement department lists. For each user, omitted existing department memberships are removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_code` | string | Yes | Exact login code of the user to update. |
| `group_codes` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | One to 100 unique users and their complete Kintone service assignments. Each services value must be [] or ['kintone']. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Departments

**Slug:** `KINTONE_UPDATE_DEPARTMENTS`

Update mutable fields for 1 to 100 existing Kintone departments, identified by exact department code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `departments` | array | Yes | One to 100 departments to update by exact code. Include only mutable fields that should change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groups` | array | Yes | One to 100 groups to update by exact code. Every item requires its replacement name; group type cannot be changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | One to 100 existing users to update by required login code. Include only the editable fields to change. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |