Search Vcf Sso Groups

Search Vcf Sso Groups
Search VCF SSO Groups (SCIM API)

Searches for user groups from VCF SSO Identity Provider using SCIM 2.0 protocol. Used to discover available AD/LDAP groups for HCX role mapping configuration.

Details:

  • Internally queries VCF SSO (vIDB) via SCIM 2.0 Groups API
  • Supports pagination (startIndex, itemsPerPage)
  • Filter by group name (partial match)
  • Returns group ID, display name, and domain
  • Maximum 100 results per page (default)

Prerequisites:

  • vIDB (VCF SSO) must be configured (/api/admin/global/config/vidb)
  • OAuth client credentials must be valid
  • HCX Manager must have network connectivity to VCF SSO

Pagination:

  • Use startIndex for pagination (1-based index)
  • Use count to control page size (max 100)
  • Check totalResults to determine if more pages exist
Request
URI
GET
https://{server}:9443/api/admin/global/config/roleMappings/idp/searchGroups
COPY
Query Parameters
string
groupName
Optional

Group name filter (partial match, case-insensitive)

groupName example
Admins
integer
count
Optional
Constraints: minimum: 1 maximum: 100 default: 100

Number of results to return (page size)

count example
50
integer
startIndex
Optional
Constraints: minimum: 1 default: 1

Starting index for pagination (1-based)

startIndex example
1
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved VCF SSO groups

Returns IdpGroupSearchResponse of type(s) application/json 
{
    "totalResults": 25,
    "startIndex": 1,
    "itemsPerPage": 10,
    "idpGroups": [
        {
            "id": "12345678-90ab-cdef-1234-567890abcdef",
            "displayName": "vsphere.local\\Administrators",
            "domainName": "vsphere.local"
        }
    ]
}
integer
totalResults
Required

Total number of groups matching the filter

integer
startIndex
Required

Starting index of returned results (1-based)

integer
itemsPerPage
Required

Number of results in this page

array of object
idpGroups
Required

List of VCF SSO groups


400

Bad request - Invalid search parameters

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error - Failed to search VCF SSO groups

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/admin/global/config/roleMappings/idp/searchGroups
On This Page
Role Mappings Operations
GET
Get Vsphere Role Mappings
PUT
Update Vsphere Role Mappings
GET
Search Vcf Sso Groups
GET
Get Vcf Sso Role Mappings
PUT
Update Vcf Sso Role Mappings