Update User's Groups
Updates information of Groups that a User belongs to.
Method | PUT |
---|---|
URL | https://{subdomain}.kintone.com/v1/user/groups.json |
Authentication | Password Authentication, Session Authentication |
Content-Type | application/json |
Contents
Permissions
Only Administrators can use this API.
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
code | String | Yes | The User's log-in name. Must be 128 characters or less. Empty strings, and characters consisting of only whitespaces are not allowed. |
groups | Array | Yes | An array of group codes to which the user belongs to. Up to 1000 group codes can be specified. If a user belongs to a group, but the group is not specified in the request, the user is removed from the group. If the array is empty, the user is removed from all groups. Dynamic groups cannot be specified. |
Sample Request
JavaScript (using Kintone REST API Request)
Update groups that user1 belongs, to group1 and group2.
|
|
curl Sample
Update groups that user1 belongs, to group1 and group2.
|
|
Response Parameters
An empty JSON object is returned.
Sample Response
|
|
Limitations
- It is not recommended run this API while performing the following operations on the Users & System Administration page:
- Updates to groups on the Groups (or Roles) page
- Importing from a file