List SCIM users with filtering

List users

curl --request GET \
  --url https://api.onecli.sh/scim/v2/Users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/scim/v2/Users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onecli.sh/scim/v2/Users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/scim/v2/Users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/scim/v2/Users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 123,
  "startIndex": 123,
  "itemsPerPage": 123,
  "Resources": [
    {}
  ]
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "<string>",
  "scimType": "<string>",
  "detail": "<string>"
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "<string>",
  "scimType": "<string>",
  "detail": "<string>"
}

GET

Users

List users

curl --request GET \
  --url https://api.onecli.sh/scim/v2/Users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/scim/v2/Users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onecli.sh/scim/v2/Users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onecli.sh/scim/v2/Users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/scim/v2/Users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 123,
  "startIndex": 123,
  "itemsPerPage": 123,
  "Resources": [
    {}
  ]
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "<string>",
  "scimType": "<string>",
  "detail": "<string>"
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "<string>",
  "scimType": "<string>",
  "detail": "<string>"
}

An RFC 7644 list. Filter with userName eq "...", and page with startIndex and count (default 100, max 500). An unknown userName returns an empty list. Related guide: User provisioning: set up SCIM. RFC 7644 list with filter (userName eq "…" only), startIndex, and count (default 100, max 500). An unknown userName answers an empty list, never 404.

Availability: Cloud · Enterprise (self-hosted). The SCIM endpoint answers 401 on an unlicensed self-hosted deployment.

SCIM lives on its own base URL: https://api.onecli.sh/scim/v2 on Cloud, http://localhost:10254/scim/v2 self-hosted. It authenticates with a SCIM token (oc_scim_…, minted at POST /org/scim/tokens), never a OneCLI API key, and speaks application/scim+json per RFC 7644. Each token is rate-limited to 600 requests per minute.

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Query Parameters

filter

string

startIndex

integer

default:1

count

integer

default:100

Response

A list response of Users

RFC 7644 list response.

schemas

string[]

Example:

[
  "urn:ietf:params:scim:api:messages:2.0:ListResponse"
]

totalResults

integer

startIndex

integer

itemsPerPage

integer

Resources

object[]

Workspace

Organization

Enterprise

Platform

List SCIM users with filtering

Authorizations

Query Parameters

Response