Get User Search | VMware Identity Broker

Get User Search

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.

basic_auth

admin

Responses

200

Successfully fetched the list of users.

Returns UserListMedia of type(s) application/scim+json

{
    "resources": [
        {
            "name": {
                "familyName": "MyFamilyName",
                "middleName": "MyMiddleName",
                "givenName": "MyGivenName"
            },
            "displayName": "My Display Name",
            "nickName": "My Casual Name",
            "profileUrl": "https://example.com/usergroup/scim/v2/Users/da916af2-4c19-4ddb-89bd-363dbb79da29",
            "active": true,
            "emails": [
                {
                    "value": "[email protected]",
                    "primary": "true",
                    "display": "my work email"
                }
            ],
            "phoneNumbers": [
                {
                    "value": "555-555-5555",
                    "type": "work",
                    "primary": true
                }
            ],
            "ims": [
                {
                    "value": "[email protected]",
                    "type": "skype",
                    "primary": true,
                    "display": "ims_example"
                }
            ],
            "photos": [
                {
                    "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
                    "type": "photo",
                    "primary": true,
                    "display": "Example photo"
                }
            ],
            "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",
            "groups": [
                {
                    "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
                    "$ref": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
                    "display": "Example Group"
                }
            ],
            "title": "Example title",
            "id": "string",
            "externalId": "string",
            "meta": {
                "location": "string",
                "version": "string",
                "lastModified": "string",
                "resourceType": "string",
                "created": "string"
            },
            "schemas": [
                "string"
            ]
        }
    ],
    "totalResults": 0,
    "itemsPerPage": 0,
    "startIndex": 0,
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

array of object

resources

Optional

A list of returned users

integer As int32 As int32

totalResults

Optional

The total number of results returned by the list or query operation

integer As int32 As int32

itemsPerPage

Optional

The number of resources returned in a list response page

integer As int32 As int32

startIndex

Optional

The 1-based index of the first result in the current set of list results

string

Optional

The unique identifier of the SCIM resource

string

externalId

Optional

The SCIM resource external identifier

object