Post Find Groups | VMware Identity Manager API

Post Find Groups

Retrieve all groups if no filter is specified, otherwise retrieve all the groups matching the given filter. This endpoint complies with the SCIM specifications, see https://tools.ietf.org/html/rfc7644#page-15. This serves the same function as the GET /scim/Groups API but using a POST method so that the length of the request is not limited.

Request

URI

POST

https://{api_host}//SAAS/jersey/manager/api/scim/Groups/.search

COPY

Request Body

the search request

SearchRequest of type(s) application/json

Required

{
    "customSchemaExtensionTypes": "string",
    "count": 50,
    "excludedAttributes": "string",
    "filter": "domain co \"test.com\"",
    "startIndex": 1,
    "sortOrder": "descending",
    "attributes": "distinguishedName",
    "sortBy": "distinguishedName"
}

string

customSchemaExtensionTypes

Optional

customSchemaExtensionTypes

integer As int32 As int32

count

Optional

The number of found resources to return starting from the given startIndex. This is used for pagination. Default is 20

string

excludedAttributes

Optional

excludedAttributes

string

filter

Optional

The search filter. When specified, only resources matching the filter expression will be returned. The filter must comply with the SCIM specification. Only 'eq','co','sw','gt','ge','lt' and 'le' are currently supported as operators

integer As int32 As int32

startIndex

Optional

Offset of the first resource to return in the list of found resources. This is used for pagination. Default is 0

string

sortOrder

Optional

The direction the resources returned should be sorted in. Allowed values are "ascending" and "descending"

string

attributes

Optional

The attributes to be returned. When specified, the returned resource will contain the minimal set of resource attributes plus the attributes or sub-attributes explicitly requested.

string

sortBy

Optional

The attribute to use to sort the found resource

Authentication

This operation uses the following authentication methods.

oauth2

Responses

200

successful operation

Returns ResourcesOfGroupResource of type(s) application/json

{
    "totalResults": 0,
    "startIndex": 0,
    "itemsPerPage": 0,
    "Resources": [
        {
            "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"
            ]
        }
    ]
}

integer As int64 As int64

totalResults

Optional

totalResults

integer As int64 As int64

startIndex

Optional

startIndex

integer As int32 As int32

itemsPerPage

Optional

itemsPerPage