Skip to content

Commit

Permalink
Add warning for SCIM as it is still experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
fflorent committed Nov 29, 2024
1 parent c33c412 commit 45e37b8
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions help/en/docs/install/scim.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,8 @@ Below is a list of environment variables you may use to configure SCIM:
- `GRIST_ENABLE_SCIM`: set its value to `true` so you enable the SCIM endpoints;
- `GRIST_SCIM_USER`: (optional) give this variable the email address of an account to give it access to the SCIM endpoints.

!!! warning "Status of SCIM"
As of November 2024, the SCIM endpoint is experimental and in active development. Also please note that the groups management is not supported yet.

!!! Note "About GRIST_SCIM_USER"
Although instance administrators (identified by the emails set in `GRIST_DEFAULT_EMAIL` or `GRIST_SUPPORT_EMAIL`) can access SCIM endpoints, it is recommended to create a dedicated account using `GRIST_SCIM_USER` for your identity provider to interact with these endpoints. This follows the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege).

0 comments on commit 45e37b8

Please sign in to comment.