Skip to main content
GET
/
scim
/
v2
/
Users
List users
curl --request GET \
  --url https://{tenant}.cubecloud.dev/api/scim/v2/Users \
  --header 'Authorization: Bearer <token>'
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 20,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "2819c223-7f76-453a-919d-413861904646",
      "userName": "jane@example.com",
      "name": {
        "givenName": "Jane",
        "familyName": "Doe"
      },
      "emails": [
        {
          "value": "jane@example.com",
          "primary": true
        }
      ],
      "active": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

SCIM bearer token issued from your Cube Cloud account settings.

Query Parameters

​
filter
string

SCIM filter expression used to narrow results, for example userName eq "jane@example.com".

​
startIndex
integer
default:1

1-based index of the first result to return. Defaults to 1.

Required range: x >= 1
​
count
integer

Maximum number of results to return per page.

Required range: x >= 0

Response

200 - application/json

A list of users.

​
schemas
string[]
Example:
[
  "urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
​
totalResults
integer
​
startIndex
integer
​
itemsPerPage
integer
​
Resources
object[]