Get User Search

Get User Search
Search for users in a tenant

This endpoint is responsible for fetching a list of users with specific criteria. For more information, check the specification: https://tools.ietf.org/html/rfc7644#section-3.4.2.

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

The VMware Identity Services tenant ID

tenant example
my-tenant
Query Parameters
string
filter
Optional
Constraints: minLength: 0 maxLength: 2000

When specified, only those resources matching the filter expression SHALL be returned. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.2).

string
sortBy
Optional

Specifies the attribute whose value. SHALL be used to order the returned responses. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.3).

string
sortOrder
Optional

The order in which the sortBy parameter is applied. Allowed values are ascending and descending. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.3).

integer
startIndex
Optional

The 1-based index of the first result in the current set of list results. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.4).

integer
count
Optional

The number of resources returned in a list response. Functionality based on SCIM 2.0 (https://tools.ietf.org/html/rfc7644#section-3.4.2.4).

string
attributes
Optional

Return resources with only requested and always returned 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 resources 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

Successfully fetched the list of users.

Returns UserListMedia of type(s) application/scim+json 
{
    "resources": [
        {
            "name": {
                "middleName": "MyMiddleName",
                "familyName": "MyFamilyName",
                "givenName": "MyGivenName"
            },
            "displayName": "My Display Name",
            "profileUrl": "https://example.com/usergroup/scim/v2/Users/da916af2-4c19-4ddb-89bd-363dbb79da29",
            "active": true,
            "nickName": "My Casual Name",
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": "true",
                    "display": "my work email"
                }
            ],
            "phoneNumbers": [
                {
                    "value": "555-555-5555",
                    "type": "work",
                    "primary": true
                }
            ],
            "photos": [
                {
                    "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
                    "type": "photo",
                    "primary": true,
                    "display": "Example photo"
                }
            ],
            "ims": [
                {
                    "value": "[email protected]",
                    "type": "skype",
                    "primary": true,
                    "display": "ims_example"
                }
            ],
            "addresses": [
                {
                    "type": "home",
                    "region": "CA",
                    "country": "USA",
                    "primary": true,
                    "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
                    "streetAddress": "456 Hollywood Blvd",
                    "postalCode": "91608",
                    "locality": "Hollywood"
                }
            ],
            "userName": "my_user_name",
            "title": "Example title",
            "groups": [
                {
                    "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
                    "$ref": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
                    "display": "Example Group"
                }
            ],
            "id": "string",
            "meta": {
                "location": "string",
                "version": "string",
                "lastModified": "string",
                "resourceType": "string",
                "created": "string"
            },
            "externalId": "string",
            "schemas": [
                "string"
            ]
        }
    ],
    "startIndex": 0,
    "totalResults": 0,
    "itemsPerPage": 0,
    "id": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "externalId": "string",
    "schemas": [
        "string"
    ]
}

400

The request contains invalid information.

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/Users
On This Page
Scim2 Operations
GET
Get User Search
POST
Create User
DELETE
Delete User
GET
Get User
PATCH
Patch User
PUT
Put User
POST
Post User Search