SCIM

Filter Users

get/scim/v2/{workspaceId}/Users

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/scim/v2/{workspaceId}/Users
  • Auth: none declared

Path parameters

workspaceIdstring required

Query parameters

filterstring
Example:userName eq "jane-doe@test.com"

Filter expression for filtering. Currently only supported filter is [eq]

startIndexnumber
Example:1

Index to start the list of results from

countnumber
Example:1

Total number of results to return

Response

schemasstring[] required

Schema Definition for the List Resource

totalResultsnumber required

Total number of results based on given filter

startIndexnumber required

Index to paginate the results

itemsPerPagenumber required

Total number of results per page

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "cj0iFquUILzBTSKd",
      "externalId": "00ub5me9eooGKzSp05d7",
      "userName": "jane-doe@test.com",
      "name": {
        "givenName": "Jane",
        "familyName": "Doe",
        "formatted": "Jane Doe"
      },
      "meta": {
        "resourceType": "User",
        "location": "https://api.carbonvoice.app/scim/v2/:workspaceId/Users/cj0iFquUILzBTSKd"
      },
      "emails": [
        {
          "primary": true,
          "value": "jane-doe@test.com"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.