Skip to main content

GroupUser resource

/GroupUser

Dictionary table

The diagram service model of the object: https://download.soffid.com/doc/console/latest/uml/com/soffid/iam/api/GroupUser.html

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

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

Query Schema

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

Request
GET http://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.GroupUser
Response 200 OK
{
    "meta": {
        "location": "http://soffid.pat.lab:8080/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.GroupUser",
        "resourceType": "Schema"
    },
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "name": "GroupUser",
    "description": "GroupUser object",
    "attributes": [
        {
            "subattributes": [
                {
                    "uniqueness": "none",
                    "name": "startDate",
                    "description": "Start date (2)",
                    "mutability": "readWrite",
                    "type": "dateTime",
                    "caseExact": true,
                    "returned": "default",
                    "multiValued": false,
                    "required": false
                },
                {
                    "uniqueness": "none",
                    "name": "comments",
                    "description": "Comments",
                    "mutability": "readWrite",
                    "type": "string",
                    "caseExact": true,
                    "returned": "default",
                    "multiValued": false,
                    "required": false
                }
            ],
            "uniqueness": "none",
            "name": "attributes",
            "description": "Custom attributes",
            "mutability": "readWrite",
            "type": "complex",
            "returned": "default",
            "multiValued": false
        },
        {
            "uniqueness": "none",
            "name": "user",
            "description": "User",
            "mutability": "readWrite",
            "type": "string",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": true
        },
        {
            "uniqueness": "none",
            "name": "group",
            "description": "Group",
            "mutability": "readWrite",
            "type": "string",
            "caseExact": true,
            "returned": "default",
            "multiValued": false,
            "required": true
        }
    ],
    "id": "urn:soffid:com.soffid.iam.api.GroupUser"
}

Full JSON example

Visit SCIM GroupUser examples page