--- updatedAt: 2026-05-27T12:54:01.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # 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](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Platform - User Provisioning", "description": "OneTrust supports cross-domain identity management through the SCIM 2.0 specification. System for Cross-Domain Identity Management (SCIM) is an open specification to help facilitate the automated management of user identities and groups in cloud applications using RESTful APIs. This allows organizations to manage and update user information and group information across domains and applications.", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" } }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "User Groups V3", "description": "V3 version APIs to manager User Groups.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json" } } ], "x-onetrust": { "spec-label": "OpenAPI 3.1.0", "links": [ "{'SCIM User & Group Provisioning': 'https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad?topicId=0TO1Q000000ItSxWAK'}" ] }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "paths": { "/api/scim/v3/Groups/{groupId}": { "get": { "operationId": "getGroupById", "summary": "Get User Group", "description": "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.\n\n> 🗒 Things to Know\n>\n> - 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).\n", "tags": [ "User Groups V3" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json" }, "parameters": [ { "name": "groupId", "in": "path", "description": "ID that uniquely identifies the SCIM group. The `groupId` can be obtained using the [Get Groups](/onetrust/reference/getgroups) API.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "550e8400-e29b-41d4-a716-446655440000" }, { "name": "excludedAttributes", "in": "query", "description": "Use this parameter to exclude members available in the Group in the response.", "required": false, "schema": { "type": "string", "default": "members" } } ], "responses": { "200": { "description": "OK\n\nGroup retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResource" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "OAUTH2": [ "SCIM", "INTEGRATION" ] } ] } } }, "components": { "schemas": { "GroupResource": { "type": "object", "properties": { "id": { "description": "Unique identifier for the user created by the OneTrust application.", "type": "string", "format": "uuid", "example": "aeb3d45d-0c05-4ff0-b635-6e3c3b2f86ea", "maxLength": 100, "readOnly": true }, "externalId": { "description": "External Id", "type": "string", "example": "3PNdoRZES0GLfV+9y1dDwQ==", "maxLength": 100 }, "meta": { "$ref": "#/components/schemas/Meta", "readOnly": true }, "schemas": { "type": "array", "items": { "type": "string", "default": "urn:ietf:params:scim:schemas:core:2.0:Group", "description": "A collection of attribute definitions that describe the contents of an entire or partial resource.", "enum": [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:onetrust:Group" ], "example": "urn:ietf:params:scim:schemas:core:2.0:Group" }, "uniqueItems": true }, "displayName": { "description": "Assessments Manager - ADFS", "type": "string", "example": "Test Group", "maxLength": 255, "minLength": 1 }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "urn:ietf:params:scim:schemas:onetrust:Group": { "$ref": "#/components/schemas/OneTrustGroup" } }, "required": [ "displayName" ], "title": "GroupResource" }, "Member": { "type": "object", "properties": { "value": { "description": "The unique ID of the user that you want to add to the Group.", "type": "string", "format": "uuid", "example": "3da9fe38-7845-4658-a96e-00071fa20c2e" }, "type": { "description": "The type of the resource.", "type": "string", "default": "User", "enum": [ "User" ] }, "$ref": { "description": "A hyperlink to the resource", "type": "string", "format": "url", "example": "/api/scim/v3/Users/1bd418b2-85dd-4f04-955f-e4870e119ef1\"", "readOnly": true } }, "required": [ "value" ], "title": "Member" }, "Meta": { "type": "object", "properties": { "created": { "description": "The date and time when the resource was created", "type": "string", "format": "date-time", "example": "2022-05-27T15:28:14.298Z" }, "lastModified": { "description": "The date and time when the resource was last modified", "type": "string", "format": "date-time", "example": "2022-05-27T15:28:14.298Z" }, "location": { "description": "The URL for the resource", "type": "string", "format": "uri", "example": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9", "maxLength": 2083, "minLength": 1 }, "version": { "description": "The version of the resource", "type": "string", "example": "W/\"f0f2a936\"", "maxLength": 100, "minLength": 1 }, "attributes": { "type": "array", "items": { "description": "The set of attributes", "example": [ "active", "emails", "userName" ] }, "uniqueItems": true }, "resourceType": { "description": "The resource type", "type": "string", "example": "Group", "enum": [ "User", "Group", "ResourceType", "ServiceProviderConfig", "Schema" ], "maxLength": 100, "minLength": 1 } }, "readOnly": true, "title": "Meta" }, "OneTrustGroup": { "type": "object", "properties": { "category": { "description": "The display name of the group", "type": "string", "example": "HR", "maxLength": 255, "minLength": 1 }, "description": { "description": "The description of the group", "type": "string", "example": "HR User Group", "maxLength": 255, "minLength": 1 } }, "title": "UserGroup" } }, "securitySchemes": { "OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "SCIM": "Grants full access to the SCIM APIs for User Provisioning. This includes all the endpoints under Users, Groups, Resources, Schemas and Service Provider." } } } } } } } ``` # Sibling pages * [Get List of User Groups](https://developer.onetrust.com/onetrust/reference/getgroups.md) * [Create User Group](https://developer.onetrust.com/onetrust/reference/creategroup.md) * [Delete User Group](https://developer.onetrust.com/onetrust/reference/deletegroup.md) * [Update User Group](https://developer.onetrust.com/onetrust/reference/updategroup.md) * [Modify User Group](https://developer.onetrust.com/onetrust/reference/modifygroup.md)