# SCIM Group type examples

## Operations

This page shows the operations that can be performed for the Group Type object

### List all

##### Request

```MarkDown
GET https://<your-domain>/soffid/webservice/scim2/v1/GroupType
```

##### Response 200 OK

```JSON
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "startIndex": 1,
  "Resources": [
    {
      "roleHolder": true,
      "updatedBy": "admin",
      "createdBy": "admin",
      "meta": {
        "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/GroupType/24552",
        "resourceType": "GroupType"
      },
      "schemas": [
        "urn:soffid:com.soffid.iam.iga.api.GroupType"
      ],
      "name": "App Billing Role",
      "description": "Role Admin for Billing application",
      "id": 24552,
      "updatedOn": "2026-03-06 08:37:45",
      "createdOn": "2026-03-06 08:37:45"
    },
    {
      "roleHolder": true,
      "updatedBy": "admin",
      "createdBy": "admin",
      "meta": {
        "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/GroupType/24553",
        "resourceType": "GroupType"
      },
      "schemas": [
        "urn:soffid:com.soffid.iam.iga.api.GroupType"
      ],
      "name": "Example group type",
      "description": "Example group type",
      "id": 24553,
      "updatedOn": "2026-03-06 08:38:43",
      "createdOn": "2026-03-06 08:38:43"
    }
  ]
}
```

### List by filter

List all group types with a filter expression.

<p class="callout info">It is allowed to use pagination and sort the information, for more information visit the [Sorting](https://bookstack.soffid.com/link/116#bkmrk-sorting) and [Pagination](https://bookstack.soffid.com/link/116#bkmrk-pagination) information.</p>

##### Request

```MarkDown
GET https://<your-domain>/soffid/webservice/scim2/v1/GroupType?filter=description co exa
```

##### Response 200 OK

```JSON
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "Resources": [
    {
      "roleHolder": true,
      "updatedBy": "admin",
      "createdBy": "admin",
      "meta": {
        "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/GroupType/24553",
        "resourceType": "GroupType"
      },
      "schemas": [
        "urn:soffid:com.soffid.iam.iga.api.GroupType"
      ],
      "name": "Example group type",
      "description": "Example group type",
      "id": 24553,
      "updatedOn": "2026-03-06 08:38:43",
      "createdOn": "2026-03-06 08:38:43"
    }
  ]
}
```

### Query by id

Query a group type by its id (primary key).

##### Request

```MarkDown
GET https://<your-domain>/soffid/webservice/scim2/v1/GroupType/24553
```

##### Response 200 OK

```JSON
{
  "roleHolder": true,
  "updatedBy": "admin",
  "createdBy": "admin",
  "meta": {
    "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/GroupType/24553",
    "resourceType": "GroupType"
  },
  "schemas": [
    "urn:soffid:com.soffid.iam.iga.api.GroupType"
  ],
  "name": "Example group type",
  "description": "Example group type",
  "id": 24553,
  "updatedOn": "2026-03-06 08:38:43",
  "createdOn": "2026-03-06 08:38:43"
}
```

### Create

#### Request

```XML
POST https://<your-domain>/soffid/webservice/scim2/v1/GroupType
```

**JSON**

```JSON
{
    "schemas": [
        "urn:soffid:com.soffid.iam.iga.api.GroupType"
    ],
    "name": "Example group type",
    "description": "Example group type",
    "roleHolder": true
}
```

##### Response 201 Created

```JSON
{
  "roleHolder": true,
  "updatedBy": "admin",
  "createdBy": "admin",
  "meta": {
    "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/GroupType/24553",
    "resourceType": "GroupType"
  },
  "schemas": [
    "urn:soffid:com.soffid.iam.iga.api.GroupType"
  ],
  "name": "Example group type",
  "description": "Example group type",
  "id": 24553,
  "updatedOn": "2026-03-06 08:38:43.002",
  "createdOn": "2026-03-06 08:38:43.002"
}
```

### Update partial

Only attributes with changes will be updated, the other will maintain the same value.

##### Request

```
PATCH https://<your-domain>/soffid/webservice/scim2/v1/GroupType/1976710
```

**JSON**

```JSON
{
    "Operations": [
        {
            "op": "replace",
            "path": "name",
            "value": "OU"
        }
    ]
}
```

##### Response 200 OK

```JSON
{
    "roleHolder": false,
    "meta": {
        "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupType/1976710",
        "resourceType": "OUType"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.iga.api.GroupType"
    ],
    "name": "OU",
    "description": "New OU",
    "id": 1976710
}
```

### Update all

This operation replaces all values in the group type.

- Note that the attribute id is required to confirm that the resource "...OUType/&lt;id&gt;" is the same that the JSON group type.
- Note that all the attributes not included in the request will be cleared in the group 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 visit [Resource data model page](https://bookstack.soffid.com/books/scim/chapter/resource-data-model-schema)

##### Request

```XML
PUT https://<your-domain>/soffid/webservice/scim2/v1/GroupType/1976590
```

**JSON**

```JSON
{
    "schemas": [
        "urn:soffid:com.soffid.iam.iga.api.GroupType"
    ],
    "id": 1976710,
    "name": "ChangeOU"
}
```

##### Response 200 OK

```JSON
{
    "roleHolder": false,
    "meta": {
        "location": "http://soffid.pat.lab:8080/soffid/webservice/scim2/v1/GroupType/1976710",
        "resourceType": "OUType"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.base.api.GroupType"
    ],
    "name": "ChangeOU",
    "id": 1976710
}
```

### Delete

<p class="callout warning">Please note after this delete, the group type has to be created again to use it in the next examples.</p>

##### Request

```MarkDown
DELETE https://<your-omain>/soffid/webservice/scim2/v1/GroupType/1976710
```

##### Response 204 No Content

```
204 No Content
```

### Error response

<p class="callout info">For more information about error response visit [https://bookstack.soffid.com/link/116#bkmrk-error-response](https://bookstack.soffid.com/link/116#bkmrk-error-response)</p>