SCIM MailList examples
Operations
List all
List all GroupUser.MailLists.
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUserMailListResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 25,3,
"startIndex": 1,
"Resources": [
{
"groupDescription"groupMembers": [],
"usersList": [
"admin",
"test2"
],
"description": "Enterprise"Test email",
"externalList": [],
"explodedUsersList": [
"test2",
"admin"
],
"roleMembers": [],
"lists": [
"test@soffid.com"
],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/480412"MailList/524071",
"resourceType": "GroupUser"MailList"
},
"domainName": "soffid.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2020-07-02 12:14:48"test",
"fullName": "test User",
"disabled": false,
"attributes": {},
"id": 480412,524071,
"user"listsBelong": "test2",
"primaryGroup": false,
"group": "enterprise"test@soffid.com"
},
{
"groupDescription"groupMembers": [],
"WorldusersList": Modified"[],
"externalList": [],
"explodedUsersList": [],
"roleMembers": [],
"lists": [],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"MailList/1976100",
"resourceType": "GroupUser"MailList"
},
"domainName": "soffid.org",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2020-08-06 15:52:12"mailList",
"fullName": "test User",
"end": "2021-02-26 13:05:44",
"disabled": true,
"attributes": {},
"id": 503629,1976100,
"user"listsBelong": "test2",
"primaryGroup": false,
"group": "world2"
},
{
"groupDescription": "Enterprise Administrators Group",
"meta": {
"location": "http://soffid.pat.lab:8080/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 GroupUsersMailList with a filter expression.
It is allowed to use pagination and sort the information, for more information visit the Sorting and Pagination information.
Request
List all GroupUserMailList with a filter expression.
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser?MailList?filter=groupDescriptiondescription eqco "World Modified"testResponse 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 4,2,
"startIndex": 1,
"Resources": [
{
"groupDescription"groupMembers": [],
"usersList": [
"admin",
"test2"
],
"description": "WorldTest Modified"email",
"externalList": [],
"explodedUsersList": [
"test2",
"admin"
],
"roleMembers": [],
"lists": [
"test@soffid.com"
],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/503629"MailList/524071",
"resourceType": "GroupUser"MailList"
},
"domainName": "soffid.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2020-08-06 15:52:12"test",
"fullName": "test User",
"end": "2021-02-26 13:05:44",
"disabled": true,
"attributes": {},
"id": 503629,524071,
"user"listsBelong": "test2",
"primaryGroup": false,
"group": "world2"test@soffid.com"
},
{
"groupDescription"groupMembers": [],
"usersList": [
"dilbert",
"admin"
],
"description": "WorldTest Modified"email mailList",
"externalList": [],
"explodedUsersList": [
"dilbert",
"admin"
],
"roleMembers": [],
"lists": [],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1519730"MailList/1976181",
"resourceType": "GroupUser"MailList"
},
"domainName": "soffid.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2021-02-20 18:08:23"mailList2",
"fullName": "Dilbert ADAMS .",
"end": "2021-02-20 19:07:45",
"disabled": true,
"attributes": {},
"id": 1519730,1976181,
"user"listsBelong": "dilbert",
"primaryGroup": false,
"group": "world2"
},
{
"groupDescription": "World Modified",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1521501",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2021-02-20 20:21:06",
"fullName": "Dilbert ADAMS .",
"disabled": false,
"attributes": {},
"id": 1521501,
"user": "dilbert",
"primaryGroup": false,
"group": "world2"
},
{
"groupDescription": "World Modified",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1558480",
"resourceType": "GroupUser"
},
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"
],
"start": "2021-02-26 13:06:24",
"fullName": "test User",
"disabled": false,
"attributes": {},
"id": 1558480,
"user": "test2",
"primaryGroup": false,
"group": "world2"
}
]
}Query by id
Query a GroupUserMailList by its id (primary key).
Request
GET http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1974296MailList/524071Response 200 OK
{
"groupDescription"groupMembers": [],
"usersList": [
"admin",
"test2"
],
"description": "HelpTest deskemail",
support"externalList": team"[],
"explodedUsersList": [
"test2",
"admin"
],
"roleMembers": [],
"lists": [
"test@soffid.com"
],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1974296"MailList/524071",
"resourceType": "GroupUser"MailList"
},
"domainName": "soffid.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2021-05-05 12:49:51"test",
"fullName": "John Smith",
"disabled": false,
"attributes": {
"startDate": "2021-05-04 00:00:00"
},
"id": 1974296,524071,
"user"listsBelong": "jsmith",
"primaryGroup": false,
"group": "it"test@soffid.com"
}Create
To create a GroupUser.MailList.
Request
POST http://<your-domain>/soffid/webservice/scim2/v1/GroupUserMailListJSON
{
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"group"name": "it"billingMailList",
"groupDescription"domainName": "Help desk support team"newdomain.com",
"user"description": "ckelp"Test email mailList",
"fullName"usersList": [
"Casey Kelp"admin",
"primaryGroup":dilbert"
true,
"attributes": {}]
}Response 201 Created
{
"groupDescription"groupMembers": [],
"usersList": [
"dilbert",
"admin"
],
"description": "HelpTest deskemail supportmailList",
team""externalList": [],
"explodedUsersList": [
"dilbert",
"admin"
],
"roleMembers": [],
"lists": [],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741"MailList/1976957",
"resourceType": "GroupUser"MailList"
},
"domainName": "newdomain.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2021-05-11 10:39:23"billingMailList",
"fullName": "Casey Kelp",
"disabled": false,
"attributes": {},
"id": 1976741,1976957,
"user"listsBelong": "ckelp",
"primaryGroup": true,
"group": "it"
}Update partial
Update only of the attributes with changes, only these atrributes will be updated, the rest will maintain the same value.
Request
PATCH http://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741JSON
{
"Operations": [
{
"op": "replace"remove",
"path": "groupDescription"usersList",
"value": "Enterprise engineering team"
},
{[
"op": "replace"admin",
"path":dilbert"
"group",
"value": "EngineeringTeam"]
}
]
}Response 200 OK
{
"groupDescription"groupMembers": [],
"description": "EnterpriseTest engineeringemail team"mailList",
"externalList": [],
"explodedUsersList": [
"dilbert",
"admin"
],
"roleMembers": [],
"lists": [],
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741"MailList/1976957",
"resourceType": "GroupUser"MailList"
},
"domainName": "newdomain.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"start"name": "2021-05-11 10:39:23"billingMailList",
"fullName": "Casey Kelp",
"disabled": false,
"attributes": {},
"id": 1976741,1976957,
"user"listsBelong": "ckelp",
"primaryGroup": true,
"group": "EngineeringTeam"
}Update all
This operation replace all values in the GroupUser.MailList.
- Note that the attribute id is required to confirm that the resource "...
GroupUser/MailList/<id>" is the same that the JSONGroupUser.MailList. - Note that all the attributes not included in the request will be cleared in the
GroupUserMailList 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://<your-domain>/soffid/webservice/scim2/v1/GroupUser/1976741MailList/1976957JSON
{
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"id": 1976741,1976957,
"group"name": "it"mailList",
"groupDescription"domainName": "Help desk support team",
"user": "ckelp",
"fullName": "Casey Kelp",
"primaryGroup": true,
"attributes": {}newdomain.com"
}Response 200 OK
{
"groupDescription": "Help desk support team",
"meta": {
"location": "http://soffid.pat.lab:8080/webservice/scim2/v1/GroupUser/1976741"MailList/1976957",
"resourceType": "GroupUser"MailList"
},
"domainName": "newdomain.com",
"schemas": [
"urn:soffid:com.soffid.iam.api.GroupUser"MailList"
],
"fullName"name": "Casey Kelp"mailList",
"disabled": false,
"attributes": {},
"id": 1976741,
"user": "ckelp",
"primaryGroup": true,
"group": "it"1976957
}Delete
Delete a role.MailList.
Please note after this delete, the account has to be created again to use it in the next examples.
Request
DELETE http://<your-omain>/soffid/webservice/scim2/v1/GroupUser/1976741MailList/1976957Response 204 No Content
204 No ContentError response
For more infomation about error response visit https://bookstack.soffid.com/link/116#bkmrk-error-response