PUT/Groups/{groupId}

Updates group information.

This API operation cannot update an external group or a dynamic group.
This API operation can add or delete only members and group members of the group type. It cannot update group members of the team type.

This API operation updates only the properties that can be set with the SCIM Group API.
Those that cannot be set with the SCIM Group API, such as the message room features, mailing list, and visibility remain the same.
To update those properties, you need to update the group information in the LINE WORKS service or use the LINE WORKS APIs.

Caution

  • For the same group, the following API operations must be called in the order they are listed: Add a group, Update a group, Update part of a group, and Delete a group.

HTTP Request

PUThttps://www.worksapis.com/scim/v2/Groups/{groupId}

Path Parameters

ParameterTypeDescription
groupId string 

Group ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

See Get a Long-Lived Token for SCIM.


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
externalId string 

ID managed by the SCIM client

 
displayName string 

Group name

It is not case-sensitive and must be unique within a domain.


required
maxLength : 100 
members array (ScimGroupMember) 

List of group members

 

ScimGroupMember

PropertyTypeDescription
value string 

Group member ID (member ID or group ID)


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL

 
id string 

Group ID

 
externalId string 

ID managed by the SCIM client

 
displayName string 

Group name

 
members array (ScimGroupMember) 

List of group members

 
meta object (meta) 
 

ScimGroupMember

PropertyTypeDescription
value string 

Group member ID (member ID or group ID)


required 
type string 

Group member type


Allowed values : USER, GROUP
readOnly : true 
display string 

Group member name (member name or group name)


readOnly : true 
$ref string 

Reference URL

Gets the detailed information of a group member.


readOnly : true 

meta

PropertyTypeDescription
resourceType string 

Resource type


Allowed values : USER, GROUP 
created string 

Creation date

 
lastModified string 

Last update date

 
location string 

Resource URI

 

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict