Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
5a54804
more content
Sep 28, 2025
dcb55ab
rearrange, more content
Sep 28, 2025
b2f6dab
change link to oauth source
Sep 28, 2025
b2e5fc3
Update website/docs/add-secure-apps/providers/scim/index.md
tanberry Sep 29, 2025
721ef62
Update website/docs/add-secure-apps/providers/scim/index.md
tanberry Sep 29, 2025
6a8c87e
dewi edits
Sep 29, 2025
b9281e1
dewi edit2
Sep 29, 2025
0c7872c
resize image, add examples
Sep 29, 2025
62f8343
tweak
Sep 29, 2025
e05a440
Update website/docs/add-secure-apps/providers/scim/index.md
tanberry Oct 3, 2025
94441c9
jens edits
Oct 3, 2025
01eafcb
more content, fix links
Oct 6, 2025
a01aec0
mpre tweaks
Oct 6, 2025
19d45cf
more info about ServiceProviderConfig
Oct 8, 2025
0ab0aad
Optimised images with calibre/image-actions
authentik-automation[bot] Oct 8, 2025
1b18c50
Optimised images with calibre/image-actions
authentik-automation[bot] Oct 8, 2025
982ec66
Optimised images with calibre/image-actions
authentik-automation[bot] Oct 8, 2025
c75844f
Optimised images with calibre/image-actions
authentik-automation[bot] Oct 8, 2025
8f302e3
tweak to bumb build
Oct 8, 2025
f4fe2a8
Update website/docs/add-secure-apps/providers/scim/index.md
tanberry Oct 9, 2025
0ecb710
Update website/docs/add-secure-apps/providers/scim/index.md
tanberry Oct 9, 2025
280f801
Update website/docs/add-secure-apps/applications/manage_apps.mdx
tanberry Oct 9, 2025
1faa380
Update website/docs/add-secure-apps/providers/index.mdx
tanberry Oct 9, 2025
aa5b7eb
Update website/docs/add-secure-apps/applications/manage_apps.mdx
tanberry Oct 9, 2025
038fb5f
Apply suggestion from @BeryJu
BeryJu Oct 13, 2025
69564e6
Apply suggestion from @BeryJu
BeryJu Oct 13, 2025
7b176cf
Apply suggestion from @BeryJu
BeryJu Oct 13, 2025
c52ad01
Apply suggestion from @BeryJu
BeryJu Oct 13, 2025
2da3a0a
Update website/docs/add-secure-apps/providers/scim/index.md
BeryJu Oct 13, 2025
81b4d43
add version badge
Oct 13, 2025
d6bf5f0
Merge branch 'main' into docs-scim
BeryJu Oct 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions website/docs/add-secure-apps/providers/scim/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,43 @@ title: SCIM Provider

SCIM (System for Cross-domain Identity Management) is a set of APIs to provision users and groups. The SCIM provider in authentik supports SCIM 2.0 and can be used to provision and sync users from authentik into other applications.

### Configuration
A SCIM provider requires a SCIM base URL for the endpoint and a token. SCIM works via HTTP requests, so authentik must be able to reach the specified endpoint. This endpoint usually ends in `/v2`, which corresponds to the SCIM version supported.

A SCIM provider requires a base URL and a token. SCIM works via HTTP requests, so authentik must be able to reach the specified endpoint.
## Authentication mode options

When configuring SCIM, you'll get an endpoint and a token from the application that accepts SCIM data. This endpoint usually ends in `/v2`, which corresponds to the SCIM version supported.
In authentik, there are two options for how to configure authentication for a SCIM provider:

The token given by the application will be sent with all outgoing SCIM requests to authenticate them.
- **Static token** provided by the application (default)
- **OAuth token** sent to the application for validation

When you create a new SCIM provider, select which **Authentication Mode** you want to implement.

![Creating a SCIM provider](./scim_oauth.png)

Whichever mode you select you'll need to enter a SCIM base **URL**, for the endpoint. The endpoint usually ends in `/v2`, which corresponds to the SCIM version supported.

### Default authentication method for a SCIM provider

With authentik's default mode, the token that you enter (provided by the application) is sent with all outgoing SCIM requests to authenticate each request.

:::info
When adding the SCIM provider, you must define the **Backchannel provider using the name of the SCIM provider that you created in authentik. Do NOT add any value in the **Provider** field (doing so will cause the provider to display as an application on the user interface, under **My apps\*\*, which is not supported for SCIM).
:::

### OAuth authentication for a SCIM provider :ak-enterprise

Configuring your SCIM provider to use OAuth for authentication means that short-lived tokens are dynamically generated through an OAuth flow and sent to the SCIM endpoint. This offers improved security and control versus a static token.

You can also add additional token request parameters to the OAuth token, such as `grant_type`, `subject_token`, or `client_assertion`.

Some examples are:

- `grant_type: client_credentials`

- `grant_type: password`

To use OAuth authentication for your application, you will need to create and connect to an [OAuth source](../../../users-sources/sources/protocols/oauth/).

### Syncing

Data is synchronized in multiple ways:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading