d8b1cd757e
* moved Sources form Integrations to Docs * files moved * fixed setting options * fixed broken links and added redirects * try single-sourcing Sources docs * tweaks * fighting links * still fighting links * fightng sidebar * fighting with sidebar * add logos and tweak * image tweaks * Optimised images with calibre/image-actions * added remaining UI definitions * kens edits --------- Co-authored-by: Tana M Berry <tana@goauthentik.com> Co-authored-by: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
---
|
|
title: SCIM Source
|
|
---
|
|
|
|
:::info
|
|
This feature is in technical preview, so please report any bugs on [GitHub](https://github.com/goauthentik/authentik/issues).
|
|
:::
|
|
|
|
The SCIM source allows other applications to directly create users and groups within authentik. SCIM provides predefined schema for users and groups, with a RESTful API, to enable automatic user provisioning and deprovisioning, SCIM is supported by applications such as Microsoft Entra ID, Google Workspace, and Okta.
|
|
|
|
The base SCIM URL is in the format of `https://authentik.company/source/scim/<source-slug>/v2`. Authentication is done via Bearer tokens that are generated by authentik. When an SCIM source is created, a service account is created and a matching token is provided.
|
|
|
|
## First steps
|
|
|
|
To set up an SCIM source, log in as an administrator into authentik. Navigate to **Directory->Federation & Social login**, and click on **Create**. Select the **SCIM Source** type in the wizard, and give the source a name.
|
|
|
|
After the source is created, click on the name of the source in the list, and you will see the **SCIM Base URL** which is used by the SCIM client. Use the **Click to copy token** button to copy the token which is used by the client to authenticate SCIM requests.
|
|
|
|
## Supported Options & Resource types
|
|
|
|
### `/v2/Users`
|
|
|
|
Endpoint to list, create, update and delete users.
|
|
|
|
### `/v2/Groups`
|
|
|
|
Endpoint to list, create, update and delete groups.
|
|
|
|
There is also the `/v2/ServiceProviderConfig` and `/v2/ResourceTypes`, which is used by SCIM-enabled applications to find out which features authentik supports.
|