Search User

The HTTP GET method searches for a user based on the filter query parameter. Wildcard characters are not allowed in the filter value. If a user is found, GET returns only one result object.

The result set returns the entire user object. This can be restricted to return only the attributes specified in the attributes query parameter

Allowed filters: userName, externalId.

Sample: /Users?filter=userName+Eq+"john.doe"&attributes=id,externalId

HTTP Request Method

GET

URI

https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users

Query Parameters

filter={filterName}

A filter is required. The allowed filter names are externalId and userName.

Request schema URI

NA

Response schema URI

urn:scim:schemas:core:2.0:ListResponse

HTTP Response Codes

The following response codes apply:

• 200
• 401
• 403
• 404

For more information, see Return Codes.

Sample Message Exchange

Request

GET /scim/v1/mypharma/Users?filter=externalId+Eq+"[e-mail]"&attributes=id,externalId HTTP 1.1
Host: example.com
Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk=
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: ...

{
    "schemas" : [
        "urn:scim:schemas:core:2.0:ListResponse"
    ],
    "totalResults" : 1,
     "Resources" : [
          {
              "schemas" : [
                "urn:scim:schemas:core:2.0:User"
            ],
            "id" : "82be808061044f9e9cef4c8f08d53ef0",
            "externalId" : "[e-mail]"
      }
    ]
}