MailList resource data model

/MailList

Dictionary table

The diagram service model of the object: http://www.soffid.org/doc/console/2.9.0/uml/com/soffid/iam/api/MailList.html

Soffid allows you to add customized data to the user object. You can do that on metadata, on the proper object.

• Main Menu > Administration > Configure Soffid > Global Settings > Metadata

It is allowed to consult all the UserMailList definition using the Schema query:

GET http://<your-domain>/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.MailList

Full JSON example

Request

GET http://<your-domain>/webservice/scim2/v1/MailList/524071

Response 200 OK

{
    "groupMembers": [],
    "usersList": [
        "admin",
        "test2"
    ],
    "description": "Test email",
    "externalList": [],
    "explodedUsersList": [
        "test2",
        "admin"
    ],
    "roleMembers": [],
    "lists": [
        "test@soffid.com"
    ],
    "meta": {
        "location": "http://<your-server>/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"
}

Response Error

For more infomation about response error visit https://bookstack.soffid.com/link/116#bkmrk-error-response