Group resource data model

/Group

Dictionary table

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

Soffid allows you to add customized data to the group object. You can do that on metadata option:

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

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

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

Full JSON example

Request

GET http://<your-domain>/webservice/scim2/v1/Group/91

Response 200 OK

{
    "organizational": false,
    "meta": {
        "location": "http://<your-domain>/webservice/scim2/v1/Group/91",
        "links": {
            "members": "http://<your-domain>/webservice/scim2/v1/User?filter=primaryGroup+eq+'admingroup'+or secondaryGroup.group.name+eq+'admingroup'",
            "administrators": "http://<your-domain>/webservice/scim2/v1/RoleAccount?filter=group.name+eq+'admingroup'"
        },
        "resourceType": "Group"
    },
    "quota": "0",
    "schemas": [
        "urn:soffid:com.soffid.iam.api.Group"
    ],
    "name": "admingroup",
    "obsolete": false,
    "description": "Enterprise Administrators",
    "parentGroup": "enterprise",
    "attributes": {},
    "id": 91
}

Response Error

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