Skip to main content

GroupUser resource

/GroupUserUserGroup

Dictionary table

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

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

  • Main Menu > Administration > Configure SoffidConfiguration > 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.iga.api.GroupUserUserGroup
Response 200 OK
{
  "meta": {
    "location": "http:https://soffid.pat.lab:8080/console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.iga.api.GroupUser"UserGroup",
    "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
    },
    {
      "uniqueness": "none",
      "name": "createdOn",
      "mutability": "readOnly",
      "type": "dateTime",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "createdBy",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "updatedOn",
      "mutability": "readOnly",
      "type": "dateTime",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "updatedBy",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    }
  ],
  "id": "urn:soffid:com.soffid.iam.iga.api.GroupUser"UserGroup"
}

Full JSON example

Visit SCIM GroupUser examples page


Back to top