HomeAPI Reference
API Reference

Search users with SCIM 2.0 protocol

get
https://api.recvue.com/api/v2.0/api/scim/Users

Returns users in SCIM 2.0 format. Accepts the same query parameters as the CoreUser GET API.

Examples:

  • GET /v2.0/scim/users - Get all users
  • GET /v2.0/scim/users?page=1&size=10 - Pagination
  • GET /v2.0/scim/[email protected] - Filter by userName
  • GET /v2.0/scim/users?status=A - Filter active users
  • GET /v2.0/scim/users?role=Manager - Filter by role
  • GET /v2.0/scim/users?sort=cu.fullName:asc - Sort

References:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by userName

string

Filter by userId

string

Filter by email address

string

Filter by status (A=Active, I=Inactive)

string

Filter by role name

sort
array of strings

Sort fields (e.g. cu.fullName:asc)

sort
string

Search keyword

string

SCIM filter expression (RFC 7644 §3.4.2.2). Supported: userName eq "value" (exact match), userName co "value" (contains match).

int32

SCIM 1-based index of first result (RFC 7644 §3.4.2)

int32

SCIM maximum number of results per page (RFC 7644 §3.4.2)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Forbidden

404

Not Found

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/scim+json

Updated 3 months ago