---
title: "Get List of User Groups"
method: GET
path: "/api/scim/v3/Groups"
tags: ["User Groups V3"]
---

# Get List of User Groups

`GET /api/scim/v3/Groups`

Use this API to retrieve a list of user groups. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.

> 🗒 Things to Know
>
> - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).
> - OneTrust supports the use of SCIM filters to identify specific user groups:
> - Filters can be applied on the `displayName` attribute.
> - The supported logical operators are `eq` (equal) and `co` (contains).
> - The `filter` query parameter is applied in the following format: attribute operator "value". For example, displayName co "Sales" would return a list of user group records that contain sales in the display name.

## Query parameters

- `startIndex` string
- `count` string
- `excludedAttributes` string
- `filter` string

## Response `200`

OK

Groups retrieved successfully.

- ListResponse
  - `schemas` string[]
  - `totalResults` integer — The total number of results in the list.
  - `startIndex` integer — TThe starting point of the result list.
  - `itemsPerPage` integer — The number of items per results page.
  - `Resources` union[]
    - union — Resources.
      - object
        - `id` string, uuid — Unique identifier for the user created by the OneTrust application.
        - `externalId` string — External Id
        - `meta` Meta
          - `created` string, date-time — The date and time when the resource was created
          - `lastModified` string, date-time — The date and time when the resource was last modified
          - `location` string, uri — The URL for the resource
          - `version` string — The version of the resource
          - `attributes` unknown[]
            - unknown
          - `resourceType` 'User' | 'Group' | 'ResourceType' | 'ServiceProviderConfig' | 'Schema' — The resource type
        - `schemas` string[]
        - `displayName` string, required — Assessments Manager - ADFS
        - `members` Member[]
          - `value` string, uuid, required — The unique ID of the user that you want to add to the Group.
          - `type` 'User' — The type of the resource.
          - `$ref` string, url — A hyperlink to the resource
        - `urn:ietf:params:scim:schemas:onetrust:Group` OneTrustGroup
          - `category` string — The display name of the group
          - `description` string — The description of the group
      - object
        - `id` string, uuid — Unique identifier for the user created by the OneTrust application.
        - `externalId` string — External Id
        - `meta` Meta
          - `created` string, date-time — The date and time when the resource was created
          - `lastModified` string, date-time — The date and time when the resource was last modified
          - `location` string, uri — The URL for the resource
          - `version` string — The version of the resource
          - `attributes` unknown[]
            - unknown
          - `resourceType` 'User' | 'Group' | 'ResourceType' | 'ServiceProviderConfig' | 'Schema' — The resource type
        - `schemas` string[]
        - `userName` string, email — Username of the user in the OneTrust application.
        - `name` Name, required
          - `familyName` string — Family name (last name) of the user.
          - `givenName` string — Given name (first name) of the user.
        - `userType` 'Internal' | 'External' — Type of the user.
        - `active` boolean — The flag to check whether the user is an active or an inactive user.
        - `groups` UserGroup[]
          - `value` string — Unique identifier of a group in the application.
          - `display` string — Name of the User Group in the application.
        - `emails` Email[]
          - `value` string, email, required — Email of the user.
          - `display` string, email — Email of the user.
          - `primary` boolean — Is the email the user's primary. Always `true` in the OneTrust application.
          - `$ref` string, string — Reference for the attribute
          - `type` string — The type of the email. In the OneTrust application, type is always 'work'.
        - `roles` string[]
        - `title` string — Job title of the user
        - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` EnterpriseUser
          - `businessUnit` string — User's business unit.
          - `division` string — The division with which the user is associated.
          - `employeeNumber` string — User's employee number or ID.
          - `officeLocation` string — The office location of the user.
          - `department` string — The department with which the user is associated.
          - `manager` Manager
            - `value` string, required — The manager's GUID or `id` in the OneTrust application. Leverage the [Get List of Users](/onetrust/reference/getusers) API to obtain a list of users. Use the manager's `id` to populate `value`.
            - `displayName` string — Manager's full name in the application.
            - `$ref` string, url — Reference URL to the user
          - `organization` string — Organization of the user within the OneTrust application.
          - `legacyManager` string — The legacy manager of the user.
      - object
        - `id` string, uuid, required — Unique identifier of the resource type
        - `name` 'Users' | 'Groups', required — Name of the resource type
        - `endpoint` string, required — Resource URL endpoint
        - `description` string, required — Description of the resource type
        - `schema` 'urn:ietf:params:scim:schemas:core:2.0:User' | 'urn:ietf:params:scim:schemas:core:2.0:Group', required — Schema URI for the resource type
        - `meta` Meta
          - `created` string, date-time — The date and time when the resource was created
          - `lastModified` string, date-time — The date and time when the resource was last modified
          - `location` string, uri — The URL for the resource
          - `version` string — The version of the resource
          - `attributes` unknown[]
            - unknown
          - `resourceType` 'User' | 'Group' | 'ResourceType' | 'ServiceProviderConfig' | 'Schema' — The resource type
        - `schemaExtensions` SchemaExtension
          - `schema` string, required — The schema extension schema
          - `required` boolean, required — True if the schema extension is required
      - object
        - `schemas` string[] — A collection of resource types supported by the service provider
        - `patch` Supported
          - `supported` boolean — Indicates whether the service provider supports the operation
        - `bulk` BulkSupported
          - `supported` boolean — Indicates whether the service provider supports the operation
          - `maxOperations` integer
          - `maxPayloadSize` integer
        - `filter` FilterSupported
          - `supported` boolean — Indicates whether the service provider supports the operation
          - `maxResults` integer
        - `changePassword` Supported
          - `supported` boolean — Indicates whether the service provider supports the operation
        - `sort` Supported
          - `supported` boolean — Indicates whether the service provider supports the operation
        - `etag` Supported
          - `supported` boolean — Indicates whether the service provider supports the operation
        - `xmlDataFormat` Supported
          - `supported` boolean — Indicates whether the service provider supports the operation
        - `authenticationSchemes` AuthenticationScheme[]
          - `name` string — Name of the authentication scheme
          - `description` string — Description of the authentication scheme
          - `specUrl` string — URI of the specification for the authentication scheme
          - `documentationUrl` string — URI to retrieve more information about the authentication scheme
          - `type` string — Type of the authentication scheme
          - `primary` boolean — Indicates whether the authentication scheme is primary
        - `meta` Meta
          - `created` string, date-time — The date and time when the resource was created
          - `lastModified` string, date-time — The date and time when the resource was last modified
          - `location` string, uri — The URL for the resource
          - `version` string — The version of the resource
          - `attributes` unknown[]
            - unknown
          - `resourceType` 'User' | 'Group' | 'ResourceType' | 'ServiceProviderConfig' | 'Schema' — The resource type

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)