Post User Search | VMware Identity Broker

Post 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.3.

Request

URI

POST

https://{api_host}//usergroup/t/{tenant}/scim/v2/Users/.search

COPY

Path Parameters

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Request Body

SearchRequestMedia of type(s) application/scim+json

Required

{
    "attributes": [
        "string"
    ],
    "count": 100,
    "filter": "string",
    "sortOrder": "descending",
    "startIndex": 1,
    "excludedAttributes": [
        "string"
    ],
    "sortBy": "string",
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

array of string

attributes

Optional

A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default

integer As int32 As int32

count

Optional

An integer indicating the desired maximum number of query results per page

string

filter

Optional

The filter string used to request a subset of resources

string

sortOrder

Optional

A string indicating the order in which the sortBy parameter is applied

Possible values are : ascending, descending,

integer As int32 As int32

startIndex

Optional

An integer indicating the 1-based index of the first query result

array of string

excludedAttributes

Optional

A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return

string

sortBy

Optional

A string indicating the attribute whose value shall be used to order the returned responses

string

Optional

The unique identifier of the SCIM resource

string

externalId

Optional

The SCIM resource external identifier

MetaMedia

meta

Optional

meta

array of string

schemas

Optional

The SCIM resource schema URIs

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",
            "addresses": [
                {
                    "type": "home",
                    "region": "CA",
                    "country": "USA",
                    "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
                    "streetAddress": "456 Hollywood Blvd",
                    "postalCode": "91608",
                    "primary": true,
                    "locality": "Hollywood"
                }
            ],
            "nickName": "My Casual Name",
            "profileUrl": "https://example.com/usergroup/scim/v2/Users/da916af2-4c19-4ddb-89bd-363dbb79da29",
            "active": true,
            "emails": [
                {
                    "value": "someone@my.host.com",
                    "primary": "true",
                    "display": "my work email"
                }
            ],
            "photos": [
                {
                    "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
                    "type": "photo",
                    "primary": true,
                    "display": "Example photo"
                }
            ],
            "phoneNumbers": [
                {
                    "value": "555-555-5555",
                    "type": "work",
                    "primary": true
                }
            ],
            "ims": [
                {
                    "value": "example@skype.com",
                    "type": "skype",
                    "primary": true,
                    "display": "ims_example"
                }
            ],
            "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",
            "externalId": "string",
            "meta": {
                "location": "string",
                "version": "string",
                "lastModified": "string",
                "resourceType": "string",
                "created": "string"
            },
            "schemas": [
                "string"
            ]
        }
    ],
    "itemsPerPage": 0,
    "totalResults": 0,
    "startIndex": 0,
    "id": "string",
    "externalId": "string",
    "meta": {
        "location": "string",
        "version": "string",
        "lastModified": "string",
        "resourceType": "string",
        "created": "string"
    },
    "schemas": [
        "string"
    ]
}

array of UserMedia

resources

Optional

A list of returned users

integer As int32 As int32

itemsPerPage

Optional

The number of resources returned in a list response page

integer As int32 As int32

totalResults

Optional

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