Groups

Teams in Contentful are referred to as groups in the SCIM specifications. You can create, remove and update teams with the SCIM API. You can also manage team members.

Group

Get a group

Patch a group

Use this endpoint to add, remove or replace team members.

Update request should contain the attribute Operations with a list of items of the following format:

User references have the following structure:

For example, to add a new user to a group we would send the following request payload:

1
{
2
  "schemas": [
3
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
4
  ],
5
  "Operations": [
6
    {
7
      "op": "add",
8
      "path": "members",
9
      "value": [
10
        {
11
          "display": "Kasia Kowalska",
12
          "value": "1xGZIRXr2WPnsLkKfREo0z"
13
        }
14
      ]
15
    }
16
  ]
17
}

It is also possible to run multiple different operations.

Delete a group

Use this endpoint to remove a team from your organization. Removing a team from your organization will in addition remove its team memberships. Any team space memberships associated with the team will also be removed.

Groups collection

Get all groups in the organization

It is possible to filter by the displayName eq filter, passing a valid group name as the value. See the Filtering section in the SCIM 2.0 specification for details.

GET /Groups?filter=displayName eq "My Group"

Create a group