List Users (SCIM)

List users using SCIM 2.0 protocol. Supports filtering and pagination.

Quick Navigation

• Endpoint
• Headers
• Query Parameters
• Response
• Success (200)
• Features
• Example
• Related Endpoints

Endpoint

GET /scim/v2/Users

Headers

Header	Required	Description
Authorization	Yes	Bearer <scim_bearer_token>
Accept	Yes	application/scim+json or application/json

Query Parameters

Parameter	Type	Required	Description
filter	string	No	SCIM filter query (e.g., userName eq "user@example.com")
startIndex	integer	No	Starting index for pagination (default: 1)
count	integer	No	Number of results per page (default: 100, max: 100)

Response

Success (200)

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 10,
  "itemsPerPage": 100,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "id": "123",
      "userName": "user@example.com",
      "name": {
        "formatted": "John Doe",
        "familyName": "Doe",
        "givenName": "John"
      },
      "active": true,
      "emails": [
        {
          "value": "user@example.com",
          "primary": true
        }
      ],
      "meta": {
        "resourceType": "User",
        "created": "2024-01-01T12:00:00Z",
        "lastModified": "2024-01-01T12:00:00Z",
        "location": "/scim/v2/Users/123"
      }
    }
  ]
}

Features

• SCIM 2.0 compliant
• Supports filtering by userName
• Pagination support
• Returns users for the organization associated with the bearer token

Example

curl -X GET "https://api.rivergen.com/scim/v2/Users?filter=userName eq \"user@example.com\"" \
  -H "Authorization: Bearer <scim_bearer_token>" \
  -H "Accept: application/scim+json"

Related Endpoints

• Get User - Get user by ID
• Create User - Create new user