# Query groups

The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response.

> For more on filtering with SCIM routes, please see RFC 7644 Filtering.


Endpoint: GET /scim/v2/Groups
Version: latest
Security: BearerAuth

## Query parameters:

  - `filter` (string)
    Clients may request a subset of resources by specifying the "filter" query parameter containing a filter expression.When specified, only those resources matching the filter expression will be returned. The expression language that is used with the filter parameter supports references to attributes and literals.

Attribute names and attribute operators used in filters are case insensitive.

> For more on filtering with SCIM routes, please see RFC 7644 Filtering.
    Example: "userName eq \"john\""

  - `attributes` (string)
    A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. Attribute names must be in standard attribute notation (Section 3.10) form.

> See Section 3.9 for additional retrieval query parameters.
    Example: "userName"

  - `excludedAttributes` (string)
    A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. This parameter will have no effect on attributes whose schema "returned" setting is "always" (see Sections 2.2 and 7 of [RFC7643]).  Attribute names must be in standard attribute notation (Section 3.10) form.

> See Section 3.9 for additional retrieval query parameters.
    Example: "givenName"

  - `sortBy` (string)
    The "sortBy" parameter specifies the attribute whose value will be used to order the returned responses. If the "sortBy" ttribute corresponds to a singular attribute, resources are sorted according to that attribute's value; if it's a multi-valued attribute, resources are sorted by the value of the primary attribute (see Section 2.4 of [RFC7643]), if any, or else the first value in the list, if any. If the attribute is complex, the attribute name must be a path to a sub-attribute in standard attribute notation (Section 3.10), e.g., .

For all attribute types, if there is no data for the specified "sortBy" value, they are sorted via the "sortOrder" parameter, i.e., they are ordered last if ascending and first if descending.
    Example: "name.givenName"

  - `sortOrder` (string)
    The order in which the "sortBy" parameter is applied. Allowed values are "ascending" and "descending". If a value for "sortBy" is provided and no "sortOrder" is specified, "sortOrder" will default to ascending. String type attributes are case insensitive by default, unless the attribute type is defined as a case-exact string. "sortOrder" must sort according to the attribute type; i.e., for case-insensitive attributes, sort the result using case-insensitive Unicode alphabetic sort order with no specific locale implied, and for case-exact attribute types, sort the result using case-sensitive Unicode alphabetic sort order.
    Enum: "ascending", "descending"

  - `startIndex` (integer)
    The 1-based index of the first query result. Values of less than  are interpreted as .

> See Section 3.4.2.3 for details about Pagination.
    Example: 1

  - `count` (integer)
    Specifies the desired maximum number of results per page. Negative values are as interpreted as .

> See Section 3.4.2.3 for details about Pagination.
    Example: 10

## Response 200 fields (application/json):

  - `schemas` (array, required)
    Example: ["urn:ietf:params:scim:api:messages:2.0:ListResponse"]

  - `totalResults` (integer)
    The total number of results returned by the list.
    Example: 2

  - `itemsPerPage` (integer)
    The number of resources returned in a list response page.
    Example: 10

  - `startIndex` (integer)
    The 1-based index of the first result in the current set of list results.

  - `resources` (array)
    Example: [{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"c3a26dd3-27a0-4dec-a2ac-ce211e105f97","displayName":"groupA","members":[{"value":"92b725cd-9465-4e7d-8c16-01f8e146b87a","ref":"https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a","type":"User"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:49.793Z","lastModified":"2011-08-01T20:31:02.315Z","location":"https://example.com/v2/Groups/ec3a26dd3-27a0-4dec-a2ac-ce211e105f97"}},{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"id":"6c5bb468-14b2-4183-baf2-06d523e03bd3","displayName":"groupB","members":[{"value":"c3a26dd3-27a0-4dec-a2ac-ce211e105f97","ref":"https://example.com/v2/Groups/c3a26dd3-27a0-4dec-a2ac-ce211e105f97","type":"Group"}],"meta":{"resourceType":"Group","created":"2011-08-01T18:29:50.873Z","lastModified":"2011-08-01T18:29:50.873Z","location":"https://example.com/v2/Groups/6c5bb468-14b2-4183-baf2-06d523e03bd3"}}]

  - `resources.id` (string)
    A unique identifier for a SCIM resource as defined by the service provider.

  - `resources.externalId` (string)
    A String that is an identifier for the resource as defined by the provisioning client.

  - `resources.displayName` (string, required)
    A human-readable name for the Group.

  - `resources.members` (array)
    A list of members of the Group.

  - `resources.members.value` (string)
    Value of an "id" attribute of a SCIM resource

  - `resources.members.$ref` (any)
    The URI of a SCIM resource such as a "User", or a "Group"