-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
website/docs: additional scim provider docs #22135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dewi-tik
wants to merge
2
commits into
main
Choose a base branch
from
website/docs--add-scim-interactive-oauth-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+87
−14
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
website/docs/add-secure-apps/providers/scim/create-scim-provider.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| title: Create a SCIM provider | ||
| --- | ||
|
|
||
| ## Create a SCIM provider with token authentication | ||
|
|
||
| To create a provider along with a corresponding application, navigate to **Applications** > **Applications** and click **New Application**. We recommend this combined approach for most common use cases. Alternatively, you can use the legacy method to solely create the provider by navigating to **Applications** > **Providers** and clicking **New Provider**. | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Applications** and click **New Application** to create an application and provider pair. | ||
| 3. On the **Application** page, define the application settings, and then click **Next**. | ||
| 4. Select **SCIM** as the **Provider Type**, and then click **Next**. | ||
| 5. On the **Configure Provider** page, provide the configuration settings, and then click **Next**. | ||
| 6. On the **Configure Bindings** page, click **Next**. | ||
| 7. Click **Create** to create both the application and the provider. | ||
|
|
||
| ### Set the SCIM provider as a backchannel provider for the application | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Applications** and click the edit icon of the new SCIM application. | ||
| 3. Click the plus icon (+) next to **Backchannel providers**. | ||
| 4. Select the new SCIM provider, and then click **Confirm**. | ||
| 5. Click **Save changes**. | ||
|
|
||
| ## Create a SCIM provider with OAuth authentication | ||
|
|
||
| There are 3 required steps to creating a SCIM provider: | ||
|
|
||
| 1. [Create an OAuth source](#create-an-oauth-source) | ||
| 2. [Create a SCIM application and provider](#create-a-scim-application-and-provider) | ||
| 3. [Set the SCIM provider as a backchannel provider for the application](#set-the-scim-provider-as-a-backchannel-provider-for-the-application) | ||
|
|
||
| If using OAuth (Interactive) mode, you will also need to: | ||
|
|
||
| 4. [Provide admin authorization](#provide-admin-authorization-oauth-interactive-mode-only) | ||
|
|
||
| ### Create an OAuth source | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Directory** > **Federation and Social login** and click **New Source**. | ||
| 3. Select **OpenID OAuth Source** as the **Source type**. | ||
| 4. On the **OpenID OAuth Source Details** page, provide the configuration settings provided by the SCIM endpoint that you are provisioning to, and then click **Create**. | ||
|
|
||
| ### Create a SCIM application and provider | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Applications** and click **New Application** to create an application and provider pair. | ||
| 3. On the **Application** page, define the application settings, and then click **Next**. | ||
| 4. Select **SCIM** as the **Provider Type**, and then click **Next**. | ||
| 5. On the **Configure Provider** page, configure the required settings. Set **Authentication mode** to the desired OAuth option, select the **OAuth source** you created in the previous section, and then click **Next**. | ||
| 6. On the **Configure Bindings** page, click **Next**. | ||
| 7. Click **Create** to create both the application and the provider. | ||
|
|
||
| ### Set the SCIM provider as a backchannel provider for the application | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Applications** and click the edit icon of the new SCIM application. | ||
| 3. Click the plus icon (+) next to **Backchannel providers**. | ||
| 4. Select the new SCIM provider, and then click **Confirm**. | ||
| 5. Click **Save changes**. | ||
|
|
||
| ### Provide admin authorization (OAuth Interactive mode only) | ||
|
|
||
| If you selected **OAuth (Interactive)** as the **Authentication mode** for the SCIM provider, you will need to authorize the initial OAuth connection. | ||
|
|
||
| 1. Log in to authentik as an administrator and open the authentik Admin interface. | ||
| 2. Navigate to **Applications** > **Providers** and click the name of the new SCIM provider. | ||
| 3. Next to **OAuth Status**, click **(Re-)Authenticate**. | ||
| 4. You should be redirected to the SCIM endpoint that you are provisioning to for authentication. | ||
| 5. Once authenticated, you should be redirected back to authentik. If successful, **OAuth Status** should now show as **Authenticated**. | ||
| This step is only required when initially configuring the SCIM provider; subsequent authentications will be automatic. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this an official name, or one you chose