SCIM GroupUser examples Operations This page shows the operations that can be performed for the object that establishes the relationship between groups and users. You can add, delete and or modify users in a group. List all Request GET http:///soffid/webservice/scim2/v1/GroupUser Response 200 OK { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 25, "startIndex": 1, "Resources": [ { "groupDescription": "Enterprise", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/480412", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2020-07-02 12:14:48", "fullName": "test User", "disabled": false, "attributes": {}, "id": 480412, "user": "test2", "primaryGroup": false, "group": "enterprise" }, { "groupDescription": "World Modified", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/503629", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2020-08-06 15:52:12", "fullName": "test User", "end": "2021-02-26 13:05:44", "disabled": true, "attributes": {}, "id": 503629, "user": "test2", "primaryGroup": false, "group": "world2" }, { "groupDescription": "Enterprise Administrators Group", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1182887", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2020-12-31 16:48:58", "fullName": "John Smith", "disabled": false, "attributes": { "comments": "This is a test", "startDate": "2021-01-01 00:00:00" }, "id": 1182887, "user": "jsmith", "primaryGroup": false, "group": "admingroup" }, ........... ] } List by filter List all GroupUsers with a filter expression. It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information. Request GET http:///soffid/webservice/scim2/v1/GroupUser?filter=groupDescription eq "Help desk support team" Response 200 OK { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 15, "startIndex": 1, "Resources": [ { "groupDescription": "Help desk support team", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1519688", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2021-02-20 17:59:15", "fullName": "Dilbert ADAMS .", "end": "2021-03-12 10:38:42", "disabled": true, "attributes": { "comments": "Comments", "startDate": "2021-02-20 00:00:00" }, "id": 1519688, "user": "dilbert", "primaryGroup": false, "group": "it" }, { "groupDescription": "Help desk support team", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1974296", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2021-05-05 12:49:51", "fullName": "John Smith", "disabled": false, "attributes": { "startDate": "2021-05-04 00:00:00" }, "id": 1974296, "user": "jsmith", "primaryGroup": false, "group": "it" }, ............... ] } Query by id Query a GroupUser by its id (primary key). Request GET http:///soffid/webservice/scim2/v1/GroupUser/1974296 Response 200 OK { "groupDescription": "Help desk support team", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1974296", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2021-05-05 12:49:51", "fullName": "John Smith", "disabled": false, "attributes": { "startDate": "2021-05-04 00:00:00" }, "id": 1974296, "user": "jsmith", "primaryGroup": false, "group": "it" } Create This option allows you to add a user to a specific group. Request POST http:///soffid/webservice/scim2/v1/GroupUser JSON { "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "group": "it", "groupDescription": "Help desk support team", "user": "ckelp", "fullName": "Casey Kelp", "primaryGroup": true, "attributes": {} } Response 201 Created { "groupDescription": "Help desk support team", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1976741", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2021-05-11 10:39:23", "fullName": "Casey Kelp", "disabled": false, "attributes": {}, "id": 1976741, "user": "ckelp", "primaryGroup": true, "group": "it" } Update partial Only attributes with changes will be updated, the other will maintain the same value. Request PATCH http:///soffid/webservice/scim2/v1/GroupUser/1976741 JSON { "Operations": [ { "op": "replace", "path": "groupDescription", "value": "Enterprise engineering team" }, { "op": "replace", "path": "group", "value": "EngineeringTeam" } ] } Response 200 OK { "groupDescription": "Enterprise engineering team", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1976741", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "start": "2021-05-11 10:39:23", "fullName": "Casey Kelp", "disabled": false, "attributes": {}, "id": 1976741, "user": "ckelp", "primaryGroup": true, "group": "EngineeringTeam" } Update all This operation replaces all values in the GroupUser. Note that the attribute id is required to confirm that the resource "...GroupUser/" is the same that the JSON GroupUser. Note that all the attributes not included in the request will be cleared in the GroupUser type and their data will be lost. Note that not all the attributes are updatable, for example, tag meta, avoid these tags. For more information see Resource data model page Request PUT http:///soffid/webservice/scim2/v1/GroupUser/1976741 JSON { "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "id": 1976741, "group": "it", "groupDescription": "Help desk support team", "user": "ckelp", "fullName": "Casey Kelp", "primaryGroup": true, "attributes": {} } Response 200 OK { "groupDescription": "Help desk support team", "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser/1976741", "resourceType": "GroupUser" }, "schemas": [ "urn:soffid:com.soffid.iam.api.GroupUser" ], "fullName": "Casey Kelp", "disabled": false, "attributes": {}, "id": 1976741, "user": "ckelp", "primaryGroup": true, "group": "it" } Delete This option allows you to remove a user from a specific group. Please note after this delete, the group user has to be created again to use it in the next examples. Request DELETE http:///soffid/webservice/scim2/v1/GroupUser/1976741 Response 204 No Content 204 No Content Error response For more information about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response