List or filter groups

GET /Groups

Returns a list of available groups, optionally filtered by query parameters

Query parameters

filter string

Filter string (e.g. displayName eq "GroupName")
startIndex integer

The 1-based index of the first result

Minimum value is 1. Default value is 1.
count integer

Maximum number of results to return

Minimum value is 0.

Responses

200 application/scim+json

List of groups
Hide response attributes Show response attributes object
- schemas array[string]
- totalResults integer
- itemsPerPage integer
- startIndex integer
- Resources array[object]
  
  Hide Resources attributes Show Resources attributes object
  
  schemas array[string]
  
  id string
  
  externalId string
  
  meta object
  
  Additional properties are allowed.
  
  Hide meta attribute Show meta attribute object
  
  resourceType string
  
  displayName string
  
  The display name of the group, typically in format 'Organization|Product|Role'
  
  members array[object]
  
  Hide members attributes Show members attributes object
  
  type string
  
  value string
  
  The identifier of the member

GET /Groups

curl \
 -X GET https://setup.adra.com/api/organizations/{organizationSid}/scim/Groups

Response examples (200)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-0-1",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-0-1",
      "displayName": "Ortiz and Sons|Engagement|Admin"
    },
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-2-4",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-2-4",
      "displayName": "Ortiz and Sons|TaskManager|User"
    },
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-2-3",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-2-3",
      "displayName": "Ortiz and Sons|TaskManager|Admin"
    },
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-2-5",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-2-5",
      "displayName": "Ortiz and Sons|TaskManager|Auditor"
    },
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-8-4",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-8-4",
      "displayName": "Ortiz and Sons|Matcher|User"
    },
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-8-3",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-8-3",
      "displayName": "Ortiz and Sons|Matcher|Admin"
    },
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-8-5",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-8-5",
      "displayName": "Ortiz and Sons|Matcher|Auditor"
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 7,
  "totalResults": 7
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "ba7abd94-280c-4445-94c1-253d5779895a-8-4",
      "meta": {
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "externalId": "ba7abd94-280c-4445-94c1-253d5779895a-8-4",
      "displayName": "Ortiz and Sons|Matcher|User"
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 1,
  "totalResults": 1
}