Search

Performs a search with provided query and returns matching result collection.

Basic Parameters

Parameter	Description
Entities	The names of the Elasticsearch indices in which to search.
Include Nested	Indicates if nested objects from returned search results should be included.
Query	The query using the Elasticsearch Query String Query syntax from the Query DSL extended by SailPoint to support Nested queries.

Advanced Parameters

Parameter	Description
Limit	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Offset	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query Type	Enum representing the currently supported query types. Additional values may be added in the future without notice.

Example Output

{
    "summary": "A collection of Identities",
    "value": [
        {
            "_type": "identity",
            "access": [
                {
                    "description": "test",
                    "displayName": "test",
                    "id": "2c918083634bc6cb01639808d40270ba",
                    "name": "test         [AccessProfile-1527264105448]",
                    "owner": {
                        "displayName": "AD Admin",
                        "id": "2c9180865c45e7e3015c46c434a80622",
                        "name": "ad.admin"
                    },
                    "source": {
                        "id": "2c9180855c45b230015c46c19b9c0202",
                        "name": "EndToEnd-ADSource"
                    },
                    "type": "ACCESS_PROFILE"
                },
                {
                    "attribute": "memberOf",
                    "description": null,
                    "displayName": "Administrators",
                    "id": "2c9180865c45e7e3015c46c457c50755",
                    "name": "Administrators",
                    "privileged": false,
                    "source": {
                        "id": "2c9180855c45b230015c46c19b9c0202",
                        "name": "EndToEnd-ADSource"
                    },
                    "standalone": false,
                    "type": "ENTITLEMENT",
                    "value": "CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local"
                },
                {
                    "description": "test",
                    "disabled": false,
                    "displayName": "test",
                    "id": "2c9180865decdaa5015e06598b293108",
                    "name": "test         [cloudRole-1503345085223]",
                    "owner": {
                        "displayName": "Albin Will",
                        "id": "2c9180865c45e7e3015c46c5030707a0",
                        "name": "will.albin"
                    },
                    "type": "ROLE"
                }
            ],
            "accessCount": 3,
            "accessProfileCount": 1,
            "accountCount": 2,
            "accounts": [
                {
                    "accountId": "CN=AD         Admin,OU=slpt-automation,DC=TestAutomationAD,DC=local",
                    "created": "2018-08-22T19:54:54.302Z",
                    "disabled": false,
                    "entitlementAttributes": {
                        "memberOf": [
                            "CN=Group         Policy Creator Owners,CN=Users,DC=TestAutomationAD,DC=local",
                            "CN=Domain Guests,CN=Users,DC=TestAutomationAD,DC=local",
                            "CN=Domain         Admins,CN=Users,DC=TestAutomationAD,DC=local",
                            "CN=Enterprise Admins,CN=Users,DC=TestAutomationAD,DC=local",
                            "CN=Schema         Admins,CN=Users,DC=TestAutomationAD,DC=local",
                            "CN=Guests,CN=Builtin,DC=TestAutomationAD,DC=local",
                            "CN=Administrators,CN=Builtin,DC=TestAutomationAD,DC=local"
                        ]
                    },
                    "id": "2c9180865c45e7e3015c46c434a80623",
                    "locked": false,
                    "manuallyCorrelated": false,
                    "name": "ad.admin",
                    "passwordLastSet": "2018-08-22T19:54:54.302Z",
                    "privileged": false,
                    "source": {
                        "id": "2c9180855c45b230015c46c19b9c0202",
                        "name": "EndToEnd-ADSource",
                        "type": "Active         Directory - Direct"
                    }
                },
                {
                    "accountId": "ad.admin",
                    "created": "2018-08-22T19:54:54.302Z",
                    "disabled": false,
                    "entitlementAttributes": null,
                    "id": "2c918083606d670c01606f35a30a0349",
                    "locked": false,
                    "manuallyCorrelated": false,
                    "name": "ad.admin",
                    "passwordLastSet": null,
                    "privileged": false,
                    "source": {
                        "id": "ff8081815c46b85b015c46b90c7c02a6",
                        "name": "IdentityNow",
                        "type": "IdentityNowConnector"
                    }
                }
            ],
            "appCount": 1,
            "apps": [
                {
                    "account": {
                        "accountId": "CN=Bob         Wilson,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
                        "id": "2c9180865c45efa4015c470be0de1606"
                    },
                    "id": "22751",
                    "name": "ADP         Workforce Now",
                    "source": {
                        "id": "2c9180855c45b230015c46e2f6a8026a",
                        "name": "Corporate         Active Directory"
                    }
                }
            ],
            "attributes": {
                "cloudAuthoritativeSource": "2c9180855c45b230015c46c19b9c0202",
                "cloudStatus": "UNREGISTERED",
                "displayName": "AD         Admin",
                "email": "SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM",
                "firstname": "AD",
                "internalCloudStatus": "UNREGISTERED",
                "iplanet-am-user-alias-list": null,
                "lastname": "Admin",
                "uid": "ad.admin",
                "workPhone": "512-942-7578"
            },
            "created": "2018-08-22T19:54:54.302Z",
            "displayName": "AD         Admin",
            "email": "SLPT.CLOUD.SAILPOINT.TEST+AD-ADMIN@GMAIL.COM",
            "employeeNumber": "O349804",
            "entitlementCount": 1,
            "firstName": "AD",
            "id": "2c9180865c45e7e3015c46c434a80622",
            "identityProfile": {
                "id": "2c918085605c8d0601606f357cb231e6",
                "name": "E2E         AD"
            },
            "inactive": false,
            "isManager": false,
            "lastName": "Admin",
            "manager": null,
            "modified": "2018-08-22T19:54:54.302Z",
            "name": "ad.admin",
            "phone": "512-942-7578",
            "processingDetails": null,
            "processingState": null,
            "protected": false,
            "roleCount": 1,
            "source": {
                "id": "2c9180855c45b230015c46c19b9c0202",
                "name": "EndToEnd-ADSource"
            },
            "status": "UNREGISTERED",
            "synced": "2018-08-22T19:54:54.302Z",
            "tags": [
                "TAG_1",
                "TAG_2"
            ]
        }
    ]
}

Workflow Library Example

Search with Sailpoint and Send Results Via Email

Preview this Workflow on desktop