Update Group's Users
Updates the list of Users that belong to a Group.
Method | PUT |
---|---|
URL | https://{subdomain}.kintone.com/v1/group/users.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 Group's code. Must be 128 characters or less. Dynamic groups |
users | Array of Strings | Yes | A list of User Codes (log-in names) belonging to the Group. Up to 1000 User Codes can be specified. Users already belonging to the group will be removed if their User Codes are not included. To remove all users belonging to the group, specify an empty array. |
Sample Request
JavaScript (using Kintone REST API Request)
|
|
curl Sample
|
|
Response Parameters
An empty JSON object is returned.
Sample Response
|
|
Limitations
-
Dynamic groups
cannot be updated.
To update the users belonging to the Groups, edit the conditions of the Dynamic groups. - 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
- Updates to groups on the
Groups (or Roles)