PUT/Groups/{groupId}

グループを更新する。
外部グループは更新できない。
グループ名、メンバーリスト以外の属性は維持される。
USER、GROUP タイプの member のみを追加/削除できる。ORGUNIT タイプの member は維持する。

注意

  • グループの登録/更新/部分更新/無効化 API は、同じグループに対しては同時に呼び出してはならず、シングルスレッドで順番に呼び出すことを推奨します。
  • SCIM Group API で設定できる属性・プロパティのみが更新されます。SCIM Group API で設定できないプロパティ (トークルーム機能、メーリングリスト機能、公開設定など) は、設定値を維持します。
  • SCIM Group API で設定できないプロパティ (トークルーム機能、メーリングリスト機能、公開設定など) は、LINE WORKS サービス画面、または LINE WORKS API を使用して変更できます。

HTTP Request

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

Path Parameters

ParameterTypeDescription
groupId string 

グループ ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}
長期トークンを参照してください。


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
externalId string 

SCIM クライアントで管理する ID

 
displayName string 

グループ名
大文字と小文字を区別せず、ドメイン内で一意である必要がある。


required
maxLength : 100 
members array (ScimGroupMember) 

グループのメンバーリスト

 

ScimGroupMember

PropertyTypeDescription
value string 

グループメンバー ID (ユーザー ID または グループ ID)


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL

 
id string 

グループ ID

 
externalId string 

SCIM クライアントで管理する ID

 
displayName string 

グループ名

 
members array (ScimGroupMember) 

グループのメンバーリスト

 
meta object (meta) 
 

ScimGroupMember

PropertyTypeDescription
value string 

グループメンバー ID (ユーザー ID または グループ ID)


required 
type string 

グループメンバータイプ


Allowed values : USER, GROUP
readOnly : true 
display string 

グループメンバー名 (ユーザー名 または グループ名)


readOnly : true 
$ref string 

参照 URL
グループメンバーの詳細情報の参照 URL


readOnly : true 

meta

PropertyTypeDescription
resourceType string 

リソースタイプ


Allowed values : USER, GROUP 
created string 

作成日時

 
lastModified string 

最終更新日時

 
location string 

リソース URI

 

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict