v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

User Groups V3

Get User Group

Use this API to retrieve details for a specific user group. 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.

get/api/scim/v3/Groups/{groupId}

Path parameters

groupIdstring uuid required

ID that uniquely identifies the SCIM group. The groupId can be obtained using the Get Groups API.

Query parameters

excludedAttributesstring

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

Response

Group retrieved successfully.

idstring uuid

Unique identifier for the user created by the OneTrust application.

externalIdstring

External Id

schemasstring[]

displayNamestring required

Assessments Manager - ADFS

Example response

{
  "id": "aeb3d45d-0c05-4ff0-b635-6e3c3b2f86ea",
  "externalId": "3PNdoRZES0GLfV+9y1dDwQ==",
  "meta": {
    "created": "2022-05-27T15:28:14.298Z",
    "lastModified": "2022-05-27T15:28:14.298Z",
    "location": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9",
    "version": "W/\"f0f2a936\"",
    "attributes": [
      [
        "active",
        "emails",
        "userName"
      ]
    ],
    "resourceType": "Group"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Test Group",
  "members": [
    {
      "value": "3da9fe38-7845-4658-a96e-00071fa20c2e",
      "$ref": "/api/scim/v3/Users/1bd418b2-85dd-4f04-955f-e4870e119ef1\""
    }
  ],
  "urn:ietf:params:scim:schemas:onetrust:Group": {
    "category": "HR",
    "description": "HR User Group"
  }
}