Skip to main content
Version: v1

ConfigCat User Provisioning (SCIM) API

The purpose of this API is to allow user and group synchronization from your Identity Provider into a ConfigCat Organization via the SCIM protocol.

Here you can read more about the user provisioning process.

Base API URL: https://scim-api.configcat.com

OpenAPI Specification

The complete specification is publicly available in the following formats:

Throttling and rate limits

All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers:

HeaderDescription
X-Rate-Limit-RemainingThe maximum number of requests remaining in the current rate limit period.
X-Rate-Limit-ResetThe time when the current rate limit period resets.

When the rate limit is exceeded by a request, the API returns with a HTTP 429 - Too many requests status along with a Retry-After HTTP header.

Authentication

To authenticate with the API you have to fill the Authorization HTTP request header with your SCIM token.

You can retrieve your credentials on the Authentication & Provisioning page. Example: Bearer 12345abcdef

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer