Get Group

Get Group

This endpoint is responsible to fetching a SCIM group. For more information, check the specification: https://tools.ietf.org/html/rfc7644#section-3.4.1.

Request
URI
GET
https://{api_host}/usergroup/t/{tenant}/scim/v2/Groups/{id}
COPY
Path Parameters
string
id
Required

The ID of the group

string
tenant
Required

The VMware Identity Services tenant ID

tenant example
my-tenant
Query Parameters
string
attributes
Optional

Return resource with only requested attributes. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.5).

attributes example
name,meta
string
excludedAttributes
Optional

Return resource with all default and always returned attributes without excluded attributes. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.5).

excludedAttributes example
name,meta
Authentication
This operation uses the following authentication methods.
Responses
200

The group was successfully fetched.

Returns GroupMedia of type(s) application/scim+json 
{
    "members": [
        {
            "value": "42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
            "$ref": "https://example.com/v2/User/42dc6b2c-4517-4e88-b1a7-79a1a1f88b5b",
            "display": "Example User"
        }
    ],
    "displayName": "Example Group",
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}
array of object
members
Optional

A list of members of the group

string
displayName
Required

A human-readable name for the group

string
id
Optional

The unique identifier of the SCIM resource

string
externalId
Optional

The SCIM resource external identifier

object
meta
Optional

The meta information of the resource

array of string
schemas
Optional

The SCIM resource schema URIs


400

Invalid filter input.

Operation doesn't return any data structure

404

The group was not found.

Operation doesn't return any data structure

500

Unexpected error.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/usergroup/t/{tenant}/scim/v2/Groups/{id}
On This Page
Scim2 Operations
GET
Search Groups
POST
Create Group
DELETE
Delete Group
GET
Get Group
PATCH
Patch Group
PUT
Put Group
POST
Post Groups Search