PATCH/Groups/{groupId}
グループを部分更新する。
外部グループは部分更新できない。
グループ名、メンバーリスト以外の属性は維持される。
USER、GROUP タイプの member のみを追加/削除できる。ORGUNIT タイプの member は維持する。
SCIM PATCH Operation の詳細については、SCIM 概要 > Patch Operation を参照してください。
注意
- グループの登録/更新/部分更新/無効化 API は、同じグループに対しては同時に呼び出してはならず、シングルスレッドで順番に呼び出すことを推奨します。
- RequestBody の Operations リストに含まれるすべての操作が有効な場合にのみ、部分更新が行われる。
- RequestBody 内の Operations リストの順に処理が行われる。
- SCIM Group API で設定できる属性・プロパティのみが更新されます。SCIM Group API で設定できないプロパティ (トークルーム機能、メーリングリスト機能、公開設定など) は、設定値を維持します。
- SCIM Group API で設定できないプロパティ (トークルーム機能、メーリングリスト機能、公開設定など) は、LINE WORKS サービス画面、または LINE WORKS API を使用して変更できます。
| Parameter | Type | Description |
|---|---|---|
| groupId | string | グループ ID required |
| Header | type | Description |
|---|---|---|
| Authorization | string | Bearer {token} required |
| Content-Type | string | application/json required |
| Property | Type | Description |
|---|---|---|
| schemas | array (string) | Schema URL required |
| Operations | array (ScimPatchOperation) | 部分修正リクエスト リスト required |
| Property | Type | Description |
|---|---|---|
| op | string | required Allowed values : add, replace, remove |
| path | string | 修正する属性の Path または Filter |
| value | object | |
| array (undefined) | ||
| string | ||
| boolean | ||
| null |
Example 1
1{2 "schemas": [3 "urn:ietf:params:scim:api:messages:2.0:PatchOp"4 ],5 "Operations": [6 {7 "op": "replace",8 "path": "displayName",9 "value": "新しいグループ名"10 },11 {12 "op": "add",13 "path": "members",14 "value": null15 }16 ]17}| Property | Type | Description |
|---|---|---|
| schemas | array (string) | Schema URL |
| id | string | グループ ID |
| externalId | string | SCIM クライアントで管理する ID |
| displayName | string | グループ名 |
| members | array (ScimGroupMember) | グループのメンバーリスト |
| meta | object (meta) |
| Property | Type | Description |
|---|---|---|
| value | string | グループメンバー ID (ユーザー ID または グループ ID) required |
| type | string | グループメンバータイプ Allowed values : USER, GROUP readOnly : true |
| display | string | グループメンバー名 (ユーザー名 または グループ名) readOnly : true |
| $ref | string | 参照 URL readOnly : true |
| Property | Type | Description |
|---|---|---|
| resourceType | string | リソースタイプ Allowed values : USER, GROUP |
| created | string | 作成日時 |
| lastModified | string | 最終更新日時 |
| location | string | リソース URI |
Bad Request
Not Found
Conflict