Search Users

Search Users

Search users in organization having username, firstName, lastName or email which "contains" search term e.g. search for "test" will return [email protected] if [email protected] is part of the organization.

Search results limited to first 20 results. Please refine the search term for accurate results. Organization members will receive basic user information. Organization owners will additionally receive role details of the users.

Request
URI
GET
https://sc2-10-185-6-200.eng.vmware.com//csp/gateway/am/api/orgs/{orgId}/users/search
COPY
Path Parameters
string
orgId
Required

orgId

Query Parameters
string
userSearchTerm
Required

userSearchTerm

Header Parameters
string
Authorization
Optional

Authorization

string
csp-auth-token
Optional

csp-auth-token


Responses
200

default response

Returns SearchUsersResponse of type(s) */*
{
    "results": [
        {
            "user": {
                "username": "string",
                "firstName": "string",
                "lastName": "string",
                "domain": "string",
                "idpId": "string",
                "accessible": false
            },
            "orgId": "string",
            "organizationRoles": [
                {
                    "id": "string",
                    "name": "string",
                    "displayName": "string",
                    "membershipType": "string"
                }
            ],
            "serviceRoles": [
                {
                    "serviceDefinitionId": "string",
                    "serviceRoles": [
                        {
                            "roleName": "string",
                            "roleDisplayName": "string",
                            "membershipType": "string"
                        }
                    ]
                }
            ]
        }
    ]
}
results
Optional

results