Get Get Group

Get Get Group

The group id is a unique internal identifier and can be retrieved using the search API /scim/Groups?filter=...

Request
URI
GET
https://{api_host}//SAAS/jersey/manager/api/scim/Groups/{id}
COPY
Path Parameters
string
id
Required

the id of the group to retrieve

id example
a1ac2b75-6c41-45e9-8349-59746c529ccb
Query Parameters
string
attributes
Optional

when specified, the returned group will contain the minimal set of user attributes plus the attributes or sub-attributes explicitly requested

attributes example
displayName

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns SdkGroupResource of type(s) application/json
{
    "displayName": "string",
    "resourceDescriptor": {
        "endpoint": "string",
        "description": "string",
        "name": "string",
        "attributeSchemas": [
            "string"
        ],
        "strictMode": false,
        "scimObject": {
            "schemas": [
                "string"
            ]
        },
        "meta": {
            "lastModified": "string",
            "version": "string",
            "location": "string",
            "created": "string"
        },
        "externalId": "string",
        "attributes": [
            {
                "subAttributes": [
                    "AttributeDescriptor Object"
                ],
                "description": "string",
                "canonicalValues": [
                    {
                        "operation": "string",
                        "type": "string",
                        "primary": false,
                        "value": "string",
                        "display": "string"
                    }
                ],
                "dataType": "string",
                "required": false,
                "caseExact": false,
                "name": "string",
                "readOnly": false,
                "multiValuedChildName": "string",
                "multiValued": false,
                "schema": "string"
            }
        ],
        "schema": "string",
        "id": "string",
        "resourceDescriptor": "ResourceDescriptor Object"
    },
    "urn:scim:schemas:extension:workspace:1.0": {
        "distinguishedName": "CN=all-admin-users,CN=Users,DC=acme,DC=com",
        "internalGroupType": "EXTERNAL",
        "domain": "acme.com",
        "description": "The group for all admin users",
        "compositionRules": "{\n  \"addedUserIds\" : [ ],\n  \"excludedUserIds\" : [ ],\n  \"rule\" : {\n    \"type\" : \"internalGroup\",\n    \"groupId\" : \"53cc45f9-2e21-4fa4-ae81-32e6fb15bd91\"\n  }\n}",
        "userStoreUuid": "acme.com",
        "parents": [
            {
                "operation": "string",
                "type": "string",
                "primary": false,
                "value": "string",
                "display": "string"
            }
        ],
        "compositionRulesV2": false,
        "email": "[email protected]"
    },
    "scimObject": {
        "schemas": [
            "string"
        ]
    },
    "meta": {
        "lastModified": "string",
        "version": "string",
        "location": "string",
        "created": "string"
    },
    "externalId": "string",
    "members": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "id": "string",
    "schemas": [
        "string"
    ]
}
string
displayName
Optional

displayName

resourceDescriptor
Optional

resourceDescriptor

urn:scim:schemas:extension:workspace:1.0
Optional

urn:scim:schemas:extension:workspace:1.0

scimObject
Optional

scimObject

meta
Optional

meta

string
externalId
Optional

externalId

members
Optional

members

string
id
Optional

id

array of string
schemas
Optional

The set of schemas that are currently contributing attributes to this group