Search User Profile (POST)
POST {{apiPath}}/scim/v2/Users/.search
The POST /scim/v2/Users/.search endpoint filters for matching user resources by performing a POST against the special .search endpoint and providing a filter value. Pagination directives can also be provided.
The response is formatted as a list response containing zero or more matching user resources in the Resources field. If the request is valid, the response returns a 200 status code, even if no matching resources are found.
The User resource and its attributes are defined in RFC 7643, Section 4.1.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/scim/v2/Users/.search' \
--header 'Accept: application/scim+json' \
--header 'Content-Type: application/scim+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"filter": "userName sw \"pc\""
}'
var options = new RestClientOptions("{{apiPath}}/scim/v2/Users/.search")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Accept", "application/scim+json");
request.AddHeader("Content-Type", "application/scim+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""filter"": ""userName sw \""pc\""""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/scim/v2/Users/.search"
method := "POST"
payload := strings.NewReader(`{
"filter": "userName sw \"pc\""
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/scim+json")
req.Header.Add("Content-Type", "application/scim+json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
POST /scim/v2/Users/.search HTTP/1.1
Host: {{apiPath}}
Accept: application/scim+json
Content-Type: application/scim+json
Authorization: Bearer {{accessToken}}
{
"filter": "userName sw \"pc\""
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/scim+json");
RequestBody body = RequestBody.create(mediaType, "{\n \"filter\": \"userName sw \\\"pc\\\"\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/scim/v2/Users/.search")
.method("POST", body)
.addHeader("Accept", "application/scim+json")
.addHeader("Content-Type", "application/scim+json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/scim/v2/Users/.search",
"method": "POST",
"timeout": 0,
"headers": {
"Accept": "application/scim+json",
"Content-Type": "application/scim+json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"filter": "userName sw \"pc\""
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/scim/v2/Users/.search',
'headers': {
'Accept': 'application/scim+json',
'Content-Type': 'application/scim+json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"filter": "userName sw \"pc\""
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/scim/v2/Users/.search"
payload = json.dumps({
"filter": "userName sw \"pc\""
})
headers = {
'Accept': 'application/scim+json',
'Content-Type': 'application/scim+json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/scim/v2/Users/.search');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Accept' => 'application/scim+json',
'Content-Type' => 'application/scim+json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "filter": "userName sw \\"pc\\""\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/scim/v2/Users/.search")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/scim+json"
request["Content-Type"] = "application/scim+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"filter": "userName sw \"pc\""
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"filter\": \"userName sw \\\"pc\\\"\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/scim/v2/Users/.search")!,timeoutInterval: Double.infinity)
request.addValue("application/scim+json", forHTTPHeaderField: "Accept")
request.addValue("application/scim+json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"Resources": [
{
"emails": [
{
"primary": true,
"type": "work",
"value": "pat.conley@runciter.com"
}
],
"id": "76b4c133-87a7-4b2f-8058-4716e78b0fd4",
"meta": {
"created": "2016-07-30T00:01:23.824Z",
"lastModified": "2016-07-30T00:01:23.824Z",
"location": "https://example.com:443/scim/v2/Users/76b4c133-87a7-4b2f-8058-4716e78b0fd4",
"resourceType": "Users"
},
"name": {
"familyName": "Conley",
"formatted": "Pat Conley",
"givenName": "Pat"
},
"schemas": [
"urn:pingidentity:schemas:sample:profile:1.0",
"urn:pingidentity:schemas:User:1.0"
],
"urn:pingidentity:schemas:sample:profile:1.0": {
"birthDate": "1948-07-13"
},
"userName": "pconley"
}
],
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 1
}