The Identity .search API is built to enable clients to filter based on User Identity attributes. Filters allow logical and grouping operators to refine search results.
+The Identity v4.1 Search API is built to enable clients to filter based on User Identity attributes. +This guide presents a set of detailed examples, advanced functionalities, and limitations of v4.1 Search. +Search is an endpoint that enables callers to retrieve a subset of users matching conditions as parameters.
-This section outlines popular use cases and assumes the caller has been authenticated within a company resource via Company JWT.
+This section outlines popular use cases and assumes the caller has been authenticated within a company resource via Company JWT. +The following examples use all available parameters to demonstrate the functionality of this API.
To use Identity v4.1 APIs, the appropriate scopes must be assigned to the requesting authentication application. Contact your SAP Concur account representative to update your Company JWT scopes to access the identity endpoints. After scopes have been granted to your authentication application, please verify the scopes. If you have questions regarding granting scopes, please contact your SAP Concur account representative.
-Retrieve the UUID of a User Identity Profile based on email address.
@@ -725,33 +728,13 @@We define a schema, as an outline of how the caller may interact with the API.
- -The schemas parameter is required for all POST requests.
| Name | -Path | -
|---|---|
| SearchRequest | -urn:ietf:params:scim:api:messages:concur:2.0:SearchRequest | -
This API implements some of the functionality defined in RFC 7644 § 3.4.3. The SearchRequest schema outlines the supported parameters that may be used when calling .search endpoint.
+This API implements the functionality defined in RFC 7644 § 3.4.3.
The schemas parameter is required and may not be empty. The required format:
"schemas": [ "urn:ietf:params:scim:api:messages:concur:2.0:SearchRequest" ]
+Adding attributes and/or excludedAttributes to a query remove attributes from each user-object in the response. The attributes parameter returns only what is requested while the excludedAttributes parameter returns everything except what is requested.
Retrieves a unique users based on search criteria.
+The filter parameter implemented all the functionality described in Filtering as a string.
+This section contributes a set of more detailed examples, limitations, and variations of expressions.
Company JWT contains companyId, and used to retrieve all users within Company.
@@ -1452,52 +1442,6 @@Return the first 1000 users who have active (field) set to true (value)
POST https://us.api.concursolutions.com/profile/identity/v4.1/Users/.search
-Accept: application/json
-Authorization: BEARER {token}
-{
- "schemas": [ "urn:ietf:params:scim:api:messages:concur:2.0:SearchRequest" ],
- "filter": "active eq true",
- "count": 1000
-}
-200 OK
-Content-Type: application/json
-{
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:ListResponse"
- ],
- "totalResults": 1234,
- "startIndex": 1,
- "itemsPerPage": 100,
- "Resources": [
- {
- "id": "uuid-v4-user-1",
- "active": "true"
- },
- {
- "id": "uuid-v4-user-2",
- "active": "false"
- },
- ...
- {
- "id": "uuid-v4-user-100",
- "active": "true"
- }
- ]
-}
-emails and addresses are multi-valued attributes.
not and ne are restricted within Complex Groupings.
- "filter": "emails[not(type eq \"work\")]"
-"filter": "addresses[type ne \"work\"]"
-or may not be nested within Complex Groupings.Filters may not contain not and ne within Complex Groupings.
"filter": "emails[not(type eq \"work\")]"
+"filter": "addresses[type ne \"work\"]"
+Filters may not nest or inside parentheses within Complex Groupings.
"filter": "emails[value ew \"@sap.com\" and (type eq \"home\" or type eq \"work\")]"
and inside of Complex Grouping.Duplicate attributes may not be conjoined with and inside of Complex Grouping.
"filter": "emails[value ew \"@concur.com\" and value ew \"@sap.com\"]"
The Identity v4.1 service is designed to create, update, and read user’s core identity profile. This service includes additional search functionality enables clients to filter based on User Identity attributes.
+The Identity v4.1 service is built to create, update, and read user’s core identity profile. This service includes advanced search functionality that enable clients to filter based on user identity attributes.
GET https://us.api.concursolutions.com/profile/identity/v4.1/Users/
+GET https://us.api.concursolutions.com/profile/identity/v4.1/Users
Accept: application/json
Authorization: BEARER {token}
@@ -1359,9 +1359,11 @@ Response
}
/Users/.search enables clients to filter based on User Identity attributes. Filters allow logical and grouping operators to refine search results.
Retrieve matching User Identity Profiles based on one or more expressions. +Expressions may be passed through the filter parameter that retrieves a subset of compliant Users. +The filter parameter supports all data types inside of the User schema including: booleans, strings, numbers, dates, and lists.