Groups

SCIM Groups represent groups in your OutThink organization. You can create, update, list and delete groups within the organization via the SCIM API.

note

Only users who are direct members of the specified groups will be ingested. The synchronization does not cascade to nested groups.

SCIM Attributes

SCIM Attribute	Description	Required	Type
displayName	Unique name of group	Yes	string
externalId	External reference identifier of the group	No	string
members	The zero or more users who are members of the group. Each user is identified by their OutThink-assigned unique user id.	No	string

Supported Operations

Operation	Description
POST /Groups	Creates a group
GET /Groups/$groupID	Gets a single group
GET /Groups	Search for groups with filtering, via GET
POST /Groups/.search	Search for groups with filtering, via POST
PUT /Groups/$groupID	Updates a single group (non-member attributes and members)
PATCH /Groups/$groupID	Updates a single group (add, replace, remove selected non-member attributes; add, remove members)
DELETE /Groups/$groupID	Deletes a single group

Example Request

The following is an example request received by the OutThink SCIM API for creating a group.

# Example request to create a group
POST https://outthink-api.azure-api.net/scim/Organizations/xxxxxxxxxxxxxx/v2/Groups
Content-Type: application/scim+json
Authorization: Bearer xxxxxxxxxxxxxx

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Marketing",
  "externalId": "81ef27b8-80ce-4c24-ba1e-067048806ecf",
  "members": [
    {
      "value": "e09df84b-4717-44bf-96ca-2cfa4e950b5b"
    },
    {
      "value": "b1952375-b78b-40bd-8848-80faab1452ae"
    }
  ]
}