# SCIM MailList examples ## Operations This page shows the operations that can be performed for the MailList object. ### List all ##### Request ```MarkDown GET http:///soffid/webservice/scim2/v1/MailList ``` ##### Response 200 OK ```JSON { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 3, "startIndex": 1, "Resources": [ { "groupMembers": [], "usersList": [ "admin", "test2" ], "description": "Test email", "externalList": [], "explodedUsersList": [ "test2", "admin" ], "roleMembers": [], "lists": [ "test@soffid.com" ], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/524071", "resourceType": "MailList" }, "domainName": "soffid.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "test", "attributes": {}, "id": 524071, "listsBelong": "test@soffid.com" }, { "groupMembers": [], "usersList": [], "externalList": [], "explodedUsersList": [], "roleMembers": [], "lists": [], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/1976100", "resourceType": "MailList" }, "domainName": "soffid.org", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "mailList", "attributes": {}, "id": 1976100, "listsBelong": "" }, ...... ] } ``` ### List by filter List all MailList with a filter expression.

It is allowed to use pagination and sort the information, for more information visit the [Sorting](https://bookstack.soffid.com/link/116#bkmrk-sorting) and [Pagination](https://bookstack.soffid.com/link/116#bkmrk-pagination) information.

##### Request ```MarkDown GET http:///soffid/webservice/scim2/v1/MailList?filter=description co test ``` ##### Response 200 OK ```JSON { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 2, "startIndex": 1, "Resources": [ { "groupMembers": [], "usersList": [ "admin", "test2" ], "description": "Test email", "externalList": [], "explodedUsersList": [ "test2", "admin" ], "roleMembers": [], "lists": [ "test@soffid.com" ], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/524071", "resourceType": "MailList" }, "domainName": "soffid.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "test", "attributes": {}, "id": 524071, "listsBelong": "test@soffid.com" }, { "groupMembers": [], "usersList": [ "dilbert", "admin" ], "description": "Test email mailList", "externalList": [], "explodedUsersList": [ "dilbert", "admin" ], "roleMembers": [], "lists": [], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/1976181", "resourceType": "MailList" }, "domainName": "soffid.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "mailList2", "attributes": {}, "id": 1976181, "listsBelong": "" } ] } ``` ### Query by id Query a MailList by its id (primary key). ##### Request ```MarkDown GET http:///soffid/webservice/scim2/v1/MailList/524071 ``` ##### Response 200 OK ```JSON { "groupMembers": [], "usersList": [ "admin", "test2" ], "description": "Test email", "externalList": [], "explodedUsersList": [ "test2", "admin" ], "roleMembers": [], "lists": [ "test@soffid.com" ], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/524071", "resourceType": "MailList" }, "domainName": "soffid.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "test", "attributes": {}, "id": 524071, "listsBelong": "test@soffid.com" } ``` ### Create #### Request ```XML POST http:///soffid/webservice/scim2/v1/MailList ``` **JSON** ```JSON { "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "billingMailList", "domainName": "newdomain.com", "description": "Test email mailList", "usersList": [ "admin", "dilbert" ] } ``` ##### Response 201 Created ```JSON { "groupMembers": [], "usersList": [ "dilbert", "admin" ], "description": "Test email mailList", "externalList": [], "explodedUsersList": [ "dilbert", "admin" ], "roleMembers": [], "lists": [], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/1976957", "resourceType": "MailList" }, "domainName": "newdomain.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "billingMailList", "attributes": {}, "id": 1976957, "listsBelong": "" } ``` ### 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** ```JSON { "Operations": [ { "op": "remove", "path": "usersList", "value": [ "admin", "dilbert" ] } ] } ``` ##### Response 200 OK ```JSON { "groupMembers": [], "description": "Test email mailList", "externalList": [], "explodedUsersList": [ "dilbert", "admin" ], "roleMembers": [], "lists": [], "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/1976957", "resourceType": "MailList" }, "domainName": "newdomain.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "billingMailList", "attributes": {}, "id": 1976957, "listsBelong": "" } ``` ### Update all This operation replaces all values in the MailList. - Note that the attribute id is required to confirm that the resource "...MailList/<id>" is the same that the JSON MailList. - Note that all the attributes not included in the request will be cleared in the MailList 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 visit [Resource data model page](https://bookstack.soffid.com/books/scim/chapter/resource-data-model-schema) ##### Request ```XML PUT http:///soffid/webservice/scim2/v1/MailList/1976957 ``` **JSON** ```JSON { "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "id": 1976957, "name": "mailList", "domainName": "newdomain.com" } ``` ##### Response 200 OK ```JSON { "meta": { "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/MailList/1976957", "resourceType": "MailList" }, "domainName": "newdomain.com", "schemas": [ "urn:soffid:com.soffid.iam.api.MailList" ], "name": "mailList", "attributes": {}, "id": 1976957 } ``` ### Delete

Please note after this delete, the mail list has to be created again to use it in the next examples.

##### Request ```MarkDown DELETE http:///soffid/webservice/scim2/v1/MailList/1976957 ``` ##### 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](https://bookstack.soffid.com/link/116#bkmrk-error-response)