Skip to main content

Integrate with Service Name

Support level: Community

What is Service-Name​

Insert a quick overview of what Service Name is and what it does. Simply describe the product and what it is, how it is used, and do not include marketing or sales-oriented content.

-- https://service.xyz

Preparation​

The following placeholders are used in this guide:

  • service.company is the FQDN of the Service installation. (Remove this for SaaS)
  • authentik.company is the FQDN of the authentik installation.
note

This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.

authentik configuration​

To support the integration of Service with authentik, you need to create an application/provider pair in authentik.

Any specific info about this integration can go here.

Create an application and provider in authentik​

  1. Log in to authentik as an admin, and open the authentik Admin interface.
  2. Navigate to Applications > Applications and click Create with Provider to create an application and provider pair. (Alternatively you can first create a provider separately, then create the application and connect it with the provider.)
  • Application: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings.
  • Choose a Provider type
    • If there is a specific provider type required, state that here.
  • Configure the Provider: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
  • Configure Bindings (optional): you can create a binding (policy, group, or user) to manage the listing and access to applications on a user's My applications page.
  1. Click Submit to save the new application and provider.

Service configuration​

Insert Service configuration

  1. Write first step here...

  2. Continue with steps....

Configuration verification​

Template sentence that you can typically use here: "To confirm that authentik is properly configured with Service Name, log out and log back in via authentik."

If there are more specific validation methods for the Service (e.g., clicking a button), include these instructions for clarity.