SCIM 2.0 API
Automate user and group membership with an identity provider.
| SCIM API Availability | |||
|---|---|---|---|
| Cloud-hosted | Generally Available | ||
| Self-hosted (3.259 Edge) | Generally Available | ||
| Self-hosted (3.148 Stable and later) | |||
Retool implements a subset of the 2.0 REST API which is often necessary to work with providers (e.g., Okta). You can also use the SCIM API directly to have your own custom user and role management system.
Access scope
Customers on either the Business or Enterprise plan can make use of Retool's SCIM 2.0 API to programmatically manage users and membership groups with an IdP.
Availability
The SCIM API is only available to cloud- and self-hosted customers on the Enterprise plan. The base URL for the API depends on which type of hosting applies to you.
Cloud
https://api.retool.com/api/scim/v2/
Self-hosted organizations must include their deployment's FQDN in the base URL.
Self-hosted
https://retool.example.com/api/scim/v2/