Get List of User 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.
  • 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 Params
string
≥ 1
Defaults to 1

Starting value of the response.

string
1 to 25
Defaults to 25

The number of entries to be returned in the response.

string
Defaults to members

Use this parameter to exclude members available in the Group in the response.

string
Defaults to displayName co "Sales"

Use this parameter to filter the list of groups based on displayName using the eq or co operators.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response
Choose an example:
application/json
*/*