SCIM User examples Operations This page shows the operations that can be performed for the user object. List all Request GET http:///soffid/webservice/scim2/v1/User Response 200 OK { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 64, "startIndex": 1, "Resources": [ { "lastName": "Pig", "profileServer": "null", "createdByUser": "hrms", "fullName": "Dad Pig", "active": true, "userName": "1", "mailAlias": "", "mailServer": "null", "firstName": "Dad", "createdDate": "2021-02-16 13:38:26", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1477909", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'1'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'1'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'1'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-05-04 09:24:54", "attributes": {}, "id": 1477909, "userType": "I", "homeServer": "null", "primaryGroupDescription": "World Original", "primaryGroup": "world" }, { "lastName": "SUZY", "profileServer": "null", "createdByUser": "hrms", "fullName": "Suzy SUZY", "active": true, "userName": "10", "mailAlias": "", "mailServer": "null", "firstName": "Suzy", "createdDate": "2021-02-16 13:38:27", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1477931", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'10'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'10'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'10'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-05-05 14:11:37", "attributes": {}, "id": 1477931, "userType": "I", "homeServer": "null", "primaryGroupDescription": "World Original", "primaryGroup": "world" }, { "lastName": "Rabbit", "profileServer": "null", "createdByUser": "hrms", "fullName": "Ricchard Rabbit", "active": true, "userName": "11", "mailAlias": "", "mailServer": "null", "firstName": "Ricchard", "createdDate": "2021-02-16 13:38:27", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1477953", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'11'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'11'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'11'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-02-17 19:06:20", "attributes": {}, "id": 1477953, "userType": "I", "homeServer": "null", "primaryGroupDescription": "World Original", "primaryGroup": "world" }, ....... ] } List by filter List all users 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/User?filter=lastName co ada&sortOrder=descending&sortBy=userName Response 200 OK { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 13, "startIndex": 1, "Resources": [ { "lastName": "ADAMS", "comments": "Changed", "profileServer": "null", "createdByUser": "soffid.bubu.lab", "fullName": "Wally ADAMS", "active": true, "userName": "wally", "mailAlias": "", "mailServer": "null", "firstName": "Wally", "createdDate": "2020-12-11 11:23:58", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1002599", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'wally'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'wally'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'wally'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-04-22 19:31:01", "attributes": { "RegisterServiceProvider": "anonymous", "manager": "admin", "PHONE": "2", "EMAIL": "wally5@test.com", }, "id": 1002599, "userType": "I", "homeServer": "null", "primaryGroupDescription": "Enterprise", "primaryGroup": "enterprise" }, { "lastName": "ADAMS", "comments": "Changed", "profileServer": "null", "createdByUser": "soffid.bubu.lab", "fullName": "Tina ADAMS", "active": true, "userName": "tina", "mailAlias": "", "mailServer": "null", "firstName": "Tina", "createdDate": "2020-12-11 12:22:07", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1004678", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'tina'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'tina'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'tina'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-04-22 19:11:17", "attributes": { "RegisterServiceProvider": "anonymous", "manager": "admin", "PHONE": "1", "EMAIL": "tina11@test.com", }, "id": 1004678, "userType": "I", "homeServer": "null", "primaryGroupDescription": "Enterprise", "primaryGroup": "enterprise" }, { "lastName": "ADAMS", "comments": "Changed", "profileServer": "null", "createdByUser": "soffid.bubu.lab", "fullName": "Teodoro ADAMS", "active": true, "userName": "ted", "mailAlias": "", "mailServer": "null", "firstName": "Teodoro", "createdDate": "2020-12-11 09:18:42", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1000190", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'ted'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'ted'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'ted'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-02-04 15:44:42", "attributes": { "RegisterServiceProvider": "anonymous", "manager": "admin", "EMAIL": "test3@gmail.com", }, "id": 1000190, "userType": "I", "homeServer": "null", "primaryGroupDescription": "Enterprise", "primaryGroup": "enterprise" }, ......... ] } Query by id Query a user by its id (primary key). Request GET http:///soffid/webservice/scim2/v1/User/1057751 Response 200 OK { "lastName": "Smith", "comments": "Changed", "createdByUser": "soffid.bubu.lab", "fullName": "John Smith", "active": true, "userName": "jsmith", "mailAlias": "", "firstName": "John", "createdDate": "2020-12-14 17:52:14", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1057751", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'jsmith'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'jsmith'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'jsmith'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-05-07 12:32:41", "attributes": { "RegisterServiceProvider": "anonymous", "manager": "admin", "EMAIL": "jsmith@test.com", "birthDate": "1970-05-26 00:00:00", "ActivationKey": "HPhl61lBlJ9fgcDtWyug0O15" }, "id": 1057751, "userType": "I", "primaryGroupDescription": "Help desk support team", "primaryGroup": "it" } Create Request POST http:///soffid/webservice/scim2/v1/User JSON { "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "userName": "ckelp", "firstName": "Cas", "lastName": "Kelp", "userType": "I", "primaryGroup": "world", "homeServer": "null", "mailServer": "null", "profileServer": "null", "active": true } Response 201 Created { "lastName": "Kelp", "profileServer": "null", "createdByUser": "admin", "fullName": "Cas Kelp", "active": true, "userName": "ckelp", "mailAlias": "", "mailServer": "null", "firstName": "Cas", "createdDate": "2021-05-11 09:06:49", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/User/1976665", "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-05-11 09:06:49", "attributes": {}, "id": 1976665, "userType": "I", "homeServer": "null", "primaryGroupDescription": "World Original", "primaryGroup": "world" } Update partial Only attributes with changes will be updated, the other will maintain the same value. If you want to add users to a group, please visit SCIM GroupUser examples page Request PATCH http:///soffid/webservice/scim2/v1/User/1976665 JSON { "Operations": [ { "op": "replace", "path": "lastName", "value": "Casey" }, { "op": "replace", "path": "middleName", "value": "XX" } ] } Response 200 OK { "lastName": "Casey", "profileServer": "null", "createdByUser": "admin", "fullName": "Casey Casey XX", "active": true, "userName": "ckelp", "mailAlias": "", "mailServer": "null", "firstName": "Casey", "createdDate": "2021-05-11 09:06:49", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/User/1976665", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'ckelp'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'ckelp'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'ckelp'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-05-11 09:33:35", "middleName": "XX", "attributes": {}, "id": 1976665, "userType": "I", "homeServer": "null", "primaryGroupDescription": "World Original", "primaryGroup": "world" } Update all This operation replaces all values in the user. Note that the attribute id is required to confirm that the resource "...User/" is the same that the JSON user. Note that all the attributes not included in the request will be cleared in the user 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/User/1976590 JSON { "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "id": 1976665, "userName": "ckelp", "firstName": "Casey", "lastName": "Kelp", "userType": "I", "primaryGroup": "world", "homeServer": "null", "mailServer": "null", "profileServer": "null", "active": true } Response 200 OK { "lastName": "Kelp", "profileServer": "null", "createdByUser": "admin", "fullName": "Casey Kelp", "active": true, "userName": "ckelp", "mailAlias": "", "mailServer": "null", "firstName": "Casey", "createdDate": "2021-05-11 09:06:49", "multiSession": false, "meta": { "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/User/1976665", "links": { "roleAccounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'ckelp'+and+enabled+eq+true", "groupUsers": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupUser?filter=user+eq+'ckelp'+and+disabled+eq+false", "accounts": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'ckelp'" }, "resourceType": "User" }, "modifiedByUser": "admin", "schemas": [ "urn:soffid:com.soffid.iam.api.User" ], "modifiedDate": "2021-05-11 09:35:24", "attributes": {}, "id": 1976665, "userType": "I", "homeServer": "null", "primaryGroupDescription": "World Original", "primaryGroup": "world" } Delete Please note after this delete, the user has to be created again to use it in the following examples. Request DELETE http:///soffid/webservice/scim2/v1/User/1976665 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