### Install NPM Packages and Start Frontend Watch Mode

Source: https://docs.goauthentik.io/developer-docs/setup/frontend-dev-environment

Run the frontend build script to install necessary npm packages and start the project in watch mode for real-time updates.

```bash
make node-install  

make web-watch  
```

--------------------------------

### Install Documentation Build Tools

Source: https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Installs or updates build dependencies for technical docs and integration guides, including Docusaurus, Prettier, and ESLint. Run this command during initial setup and if build checks fail.

```bash
make docs-install  
```

--------------------------------

### Run the Development Server

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Starts the authentik application for development. This command should be executed from the root of your installation directory.

```bash
make run
```

--------------------------------

### Start User Agent on Headless Server (Debian-based)

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/linux

Manually starts the user agent service on a headless server.

```bash
systemctl start --user ak-agent
```

--------------------------------

### Install Authentik Helm Chart

Source: https://docs.goauthentik.io/install-config/install/kubernetes

Execute these commands to add the authentik Helm repository, update it, and install the chart with your custom values.

```bash
helm repo add authentik https://charts.goauthentik.io
helm repo update
helm upgrade --install authentik authentik/authentik -f values.yaml
```

--------------------------------

### Start Backend Containers with Docker Compose

Source: https://docs.goauthentik.io/developer-docs/setup/frontend-dev-environment

In a separate terminal, start the backend containers using Docker Compose with the specified configuration files.

```bash
docker compose -f lifecycle/container/compose.yml -f compose.override.yml up -d  
```

--------------------------------

### Start Authentik Stack

Source: https://docs.goauthentik.io/troubleshooting/postgres/upgrade_docker

Starts the full authentik stack, forcing recreation of services if necessary. Ensure the temporary 'network_mode: none' setting has been removed from the PostgreSQL service in compose.yml.

```bash
docker compose up --force-recreate -d
```

--------------------------------

### Install Python and JavaScript Dependencies

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Installs all necessary JavaScript and Python dependencies for the backend and creates an isolated Python virtual environment. This command must be run from the project root.

```bash
make install
```

--------------------------------

### Install GPG Key on Debian-based Systems

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/linux

Installs the required GPG key for the authentik repository on Debian-based systems.

```bash
curl -fsSL https://pkg.goauthentik.io/keys/gpg-key.asc | sudo gpg --dearmor -o /usr/share/keyrings/authentik-keyring.gpg
```

--------------------------------

### GET /managed/blueprints/

Source: https://docs.goauthentik.io/releases/2024.4

List all blueprint instances.

```APIDOC
## GET /managed/blueprints/

### Description
List all blueprint instances.

### Method
GET

### Endpoint
/managed/blueprints/

### Response
#### Success Response (200)
- **results** (array) - A list of blueprint instances.
  - **items** (object) - Info about a single blueprint instance file.
    - **status** (string) - The status of the blueprint instance.
```

--------------------------------

### GET /sources/all/

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves a list of all configured sources.

```APIDOC
## GET /sources/all/

### Description
Retrieves a list of all configured sources, including their user matching and policy engine modes.

### Method
GET

### Endpoint
/sources/all/

### Response
#### Success Response (200 OK)
- **results** (array) - A list of sources.
  - **user_matching_mode** (string) - How the source determines if an existing user should be authenticated or a new user enrolled.
  - **policy_engine_mode** (string) - The policy engine mode for the source.
```

--------------------------------

### Pull and start authentik services

Source: https://docs.goauthentik.io/install-config/install/docker-compose

After downloading the compose file and configuring secrets, pull the latest authentik images and start the services in detached mode.

```bash
docker compose pull
```

```bash
docker compose up -d
```

--------------------------------

### Install Authentik Agent Packages on RedHat-based Systems

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/linux

Refreshes package metadata and installs the core authentik Agent packages using YUM.

```bash
sudo yum install -y authentik-cli authentik-agent authentik-sysd
```

--------------------------------

### GET /core/applications/

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves a list of applications.

```APIDOC
## GET /core/applications/

### Description
Retrieves a list of applications.

### Method
GET

### Endpoint
/core/applications/

### Response
#### Success Response (200 OK)
- **results** (array) - A list of application objects.
  - **policy_engine_mode** (string) - The policy engine mode for the application.
```

--------------------------------

### Start E2E Test Services

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Use this command to start the end-to-end test services using Docker Compose. This is necessary for running E2E tests.

```docker
docker compose -f tests/e2e/compose.yml up -d
```

--------------------------------

### Install Optional Packages for SSH/Local Login on RedHat-based Systems

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/linux

Installs optional packages required for SSH server authentication and local device login using YUM.

```bash
sudo yum install -y libnss-authentik libpam-authentik
```

--------------------------------

### GET /admin/apps/

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves a list of applications.

```APIDOC
## GET /admin/apps/

### Description
Retrieves a list of applications.

### Method
GET

### Endpoint
/admin/apps/
```

--------------------------------

### Initialize the Database

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Applies all pending database migrations to set up the development database schema. Run from the project root.

```bash
make migrate
```

--------------------------------

### Get License Install ID

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves the license installation ID.

```APIDOC
## GET /enterprise/license/get_install_id/

### Description
Retrieves the license installation ID.

### Method
GET

### Endpoint
/enterprise/license/get_install_id/
```

--------------------------------

### Watch Integrations Documentation Changes

Source: https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Starts a local development server for the integrations site. It rebuilds the site in real time as changes are made to Markdown files in the `website/integrations` directory.

```bash
make integrations-watch
```

--------------------------------

### Install Node.js on macOS

Source: https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Installs Node.js version 24 on macOS using Homebrew. Ensure Node.js is installed before proceeding with other setup steps.

```bash
brew install node@24  
```

--------------------------------

### API GET Request with AKQL Search Parameter

Source: https://docs.goauthentik.io/sys-mgmt/akql

Example of how to use AKQL in a GET request to the API. The query must be URL-encoded.

```HTTP
GET /api/v3/core/users/?search=username%20%3D%20%22bob%22
```

--------------------------------

### POST /managed/blueprints/

Source: https://docs.goauthentik.io/releases/2024.4

Create a new blueprint instance.

```APIDOC
## POST /managed/blueprints/

### Description
Create a new blueprint instance.

### Method
POST

### Endpoint
/managed/blueprints/

### Response
#### Success Response (201 Created)
- **status** (string) - The status of the created blueprint instance.
```

--------------------------------

### GET /providers/oauth2/{id}/setup_urls/

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves setup URLs for OAuth2 providers.

```APIDOC
## GET /providers/oauth2/{id}/setup_urls/

### Description
Retrieves setup URLs for OAuth2 providers.

### Method
GET

### Endpoint
/providers/oauth2/{id}/setup_urls/
```

--------------------------------

### Start Required Services with Docker Compose

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Use this command to bring up the essential services like PostgreSQL and Sentry that authentik depends on. Ensure you are in the project root directory.

```bash
docker compose -f scripts/compose.yml up -d
```

--------------------------------

### Example AWS STS Get Caller Identity Output

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/device-authentication/cli-app-authentication/aws

This is an example of the expected output when `aws sts get-caller-identity` is run successfully after configuring AWS CLI authentication with authentik. It confirms the assumed role and account.

```json
{
    "UserId": "xxxxxx",
    "Account": "<account_id>",
    "Arn": "arn:aws:sts::<account_id>:assumed-role/<role name>/<authentik username>"
}
```

--------------------------------

### POST /sources/plex/

Source: https://docs.goauthentik.io/releases/2024.4

Creates a new Plex source. Configurable with user matching and policy engine modes.

```APIDOC
## POST /sources/plex/

### Description
Creates a new Plex source. Configurable with user matching and policy engine modes.

### Method
POST

### Endpoint
/sources/plex/

### Parameters
#### Request Body
- **user_matching_mode** (string) - Required - How the source determines if an existing user should be authenticated or a new user enrolled.
- **policy_engine_mode** (string) - Required - How the source determines if an existing user should be authenticated or a new user enrolled.

### Response
#### Success Response (201 Created)
- **user_matching_mode** (string) - How the source determines if an existing user should be authenticated or a new user enrolled.
- **policy_engine_mode** (string) - How the source determines if an existing user should be authenticated or a new user enrolled.

### Response Example
```json
{
  "user_matching_mode": "string",
  "policy_engine_mode": "string"
}
```
```

--------------------------------

### Run with Hot-Reloading

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Starts the authentik server with hot-reloading enabled, which automatically restarts the server when code changes are detected. Requires 'watchexec' to be installed.

```bash
make run-watch
```

--------------------------------

### Watch Documentation Changes

Source: https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Starts a local development server for the documentation site. It rebuilds the site in real time as changes are made to Markdown files in the `website/docs` directory.

```bash
make docs-watch
```

--------------------------------

### Validate Phone Number with Expression Policy

Source: https://docs.goauthentik.io/add-secure-apps/flows-stages/stages/authenticator_sms

Use an expression policy to validate phone numbers collected in a Prompt stage. This example checks if the number starts with a specific prefix and returns an error message if invalid.

```python
phone_number = regex_replace(request.context["prompt_data"]["phone"], r"\s+", "")

if phone_number.startswith("+1234"):

    return True

ak_message("Invalid phone number or missing region code")

return False
```

--------------------------------

### Traefik IngressRoute Configuration

Source: https://docs.goauthentik.io/add-secure-apps/providers/proxy/server_traefik

Applies the created authentik middleware to specific routes within a Traefik IngressRoute. This example routes traffic for 'app.company' through the authentik middleware and also handles paths starting with '/outpost.goauthentik.io/' by directing them to the authentik Outpost service.

```yaml
spec:
    routes:
        - kind: Rule
          match: "Host(`app.company`)"
          middlewares:
              - name: authentik
                namespace: authentik
          priority: 10
          services: # Unchanged
        # This part is only required for single-app setups
        - kind: Rule
          match: "Host(`app.company`) && PathPrefix(`/outpost.goauthentik.io/`)"
          priority: 15
          services:
              - kind: Service
                # Or, to use an external Outpost, create an ExternalName service and reference that here.
                # See https://kubernetes.io/docs/concepts/services-networking/service/#externalname
                name: ak-outpost-example-outpost
                port: 9000

```

--------------------------------

### Download Invitation Enrollment Blueprint

Source: https://docs.goauthentik.io/users-sources/user/invitations

Use this command to download the recommended blueprint for invitation-based enrollment flows. This blueprint includes separate flows for external and internal users, automatic group assignment, and example invitations.

```bash
wget https://goauthentik.io/blueprints/example/flows-invitation-enrollment.yaml
```

--------------------------------

### Install Debian/Ubuntu Dependencies

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Installs Python package manager 'uv' and essential system dependencies for Debian/Ubuntu-based Linux distributions. Adjust the command if some packages are already installed.

```bash
pip install uv
sudo apt-get install -y \
libgss-dev \
ষুধ 
krb5-config \
libkrb5-dev \
libxml2 \
libxslt1-dev \
libxmlsec1 \
xmlsec1 \
postgresql-server-dev-all \
postgresql \
cmake
```

--------------------------------

### Install ldapsearch Utility

Source: https://docs.goauthentik.io/add-secure-apps/providers/ldap/create-ldap-provider

Installs the `ldapsearch` command-line tool on Debian-based, CentOS-based, and macOS systems.

```bash
sudo apt-get install ldap-utils -y # Debian-based systems  
sudo yum install openldap-clients -y # CentOS-based systems  
brew install openldap #macOS based systems (requires Homebrew to be installed)  
```

--------------------------------

### POST /sources/saml/

Source: https://docs.goauthentik.io/releases/2024.4

Creates a new SAML source with detailed configuration options.

```APIDOC
## POST /sources/saml/

### Description
Creates a new SAML source with detailed configuration options.

### Method
POST

### Endpoint
/sources/saml/

### Parameters
#### Request Body
- **user_matching_mode** (string) - Required - How the source determines if an existing user should be authenticated or a new user enrolled.
- **name_id_policy** (string) - Optional - NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
- **policy_engine_mode** (string) - Required - How the source determines if an existing user should be authenticated or a new user enrolled.
- **binding_type** (string) - Required
- **digest_algorithm** (string) - Required
- **signature_algorithm** (string) - Required

### Response
#### Success Response (201 Created)
- **user_matching_mode** (string) - How the source determines if an existing user should be authenticated or a new user enrolled.
- **name_id_policy** (string) - NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
- **policy_engine_mode** (string) - How the source determines if an existing user should be authenticated or a new user enrolled.
- **binding_type** (string)
- **digest_algorithm** (string)
- **signature_algorithm** (string)

### Response Example
```json
{
  "user_matching_mode": "string",
  "name_id_policy": "string",
  "policy_engine_mode": "string",
  "binding_type": "string",
  "digest_algorithm": "string",
  "signature_algorithm": "string"
}
```
```

--------------------------------

### POST /core/applications/

Source: https://docs.goauthentik.io/releases/2024.4

Creates a new application.

```APIDOC
## POST /core/applications/

### Description
Creates a new application.

### Method
POST

### Endpoint
/core/applications/

### Parameters
#### Request Body
- **policy_engine_mode** (string) - Required - The policy engine mode for the application.
```

--------------------------------

### GET /providers/radius/{id}/used_by/

Source: https://docs.goauthentik.io/releases/2024.4

Get a list of objects that are referencing a specific Radius provider.

```APIDOC
## GET /providers/radius/{id}/used_by/

### Description
Retrieves a list of all objects that are currently referencing the specified Radius provider by its ID.

### Method
GET

### Endpoint
/providers/radius/{id}/used_by/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the Radius provider.

### Response
#### Success Response (200 OK)
- **results** (array) - A list of objects referencing the queried object.
  - **action** (string) - The action associated with the reference.
```

--------------------------------

### GET /providers/rac/{id}/used_by/

Source: https://docs.goauthentik.io/releases/2024.4

Get a list of objects that are referencing a specific RAC provider.

```APIDOC
## GET /providers/rac/{id}/used_by/

### Description
Retrieves a list of all objects that are currently referencing the specified RAC provider by its ID.

### Method
GET

### Endpoint
/providers/rac/{id}/used_by/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the RAC provider.

### Response
#### Success Response (200 OK)
- **results** (array) - A list of objects referencing the queried object.
  - **action** (string) - The action associated with the reference.
```

--------------------------------

### POST /sources/saml/

Source: https://docs.goauthentik.io/releases/2026.5

Creates a SAML source.

```APIDOC
## POST /sources/saml/

### Description
Creates a new SAML source.

### Method
POST

### Endpoint
/sources/saml/

### Request Body
- **force_authn** (boolean) - Optional - When enabled, the IdP will re-authenticate the user even if a session exists.

### Response
#### Success Response (201 Created)
- **force_authn** (boolean) - Optional - When enabled, the IdP will re-authenticate the user even if a session exists.
```

--------------------------------

### GET /providers/proxy/{id}/used_by/

Source: https://docs.goauthentik.io/releases/2024.4

Get a list of objects that are referencing a specific Proxy provider.

```APIDOC
## GET /providers/proxy/{id}/used_by/

### Description
Retrieves a list of all objects that are currently referencing the specified Proxy provider by its ID.

### Method
GET

### Endpoint
/providers/proxy/{id}/used_by/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the Proxy provider.

### Response
#### Success Response (200 OK)
- **results** (array) - A list of objects referencing the queried object.
  - **action** (string) - The action associated with the reference.
```

--------------------------------

### Run Frontend with Live Reload

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Builds the authentik UI and enables live reloading for real-time feedback as you make changes. Access the UI at http://localhost:9000/ after running.

```bash
make web-watch
```

--------------------------------

### GET /providers/oauth2/{id}/used_by/

Source: https://docs.goauthentik.io/releases/2024.4

Get a list of objects that are referencing a specific OAuth2 provider.

```APIDOC
## GET /providers/oauth2/{id}/used_by/

### Description
Retrieves a list of all objects that are currently referencing the specified OAuth2 provider by its ID.

### Method
GET

### Endpoint
/providers/oauth2/{id}/used_by/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the OAuth2 provider.

### Response
#### Success Response (200 OK)
- **results** (array) - A list of objects referencing the queried object.
  - **action** (string) - The action associated with the reference.
```

--------------------------------

### Check authentik Component Versions

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/macos

Run this command to display the version information for all installed authentik components on your system.

```bash
ak version
```

--------------------------------

### Verify authentik Agent Installation

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/macos

Run this command in the Terminal to confirm that the authentik Agent has been successfully installed on your macOS system.

```bash
ak
```

--------------------------------

### Install Authentik Agent Packages on Debian-based Systems

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/linux

Updates package repositories and installs the core authentik Agent packages.

```bash
sudo apt update
sudo apt install authentik-cli authentik-agent authentik-sysd
```

--------------------------------

### POST /stages/authenticator/duo/{stage_uuid}/import_device_manual/

Source: https://docs.goauthentik.io/releases/2024.4

Manually imports a device for a Duo authenticator stage.

```APIDOC
## POST /stages/authenticator/duo/{stage_uuid}/import_device_manual/

### Description
Manually imports a device for a Duo authenticator stage.

### Method
POST

### Endpoint
/stages/authenticator/duo/{stage_uuid}/import_device_manual/
```

--------------------------------

### GET /sources/plex/

Source: https://docs.goauthentik.io/releases/2026.5

Retrieves Plex source configurations.

```APIDOC
## GET /sources/plex/

### Description
Retrieves Plex source configurations.

### Method
GET

### Endpoint
/sources/plex/

### Parameters
#### Query Parameters
- **group_matching_mode** (string) - Optional - The mode for matching groups.
- **user_matching_mode** (string) - Optional - The mode for matching users.
```

--------------------------------

### POST /policies/dummy/

Source: https://docs.goauthentik.io/releases/2024.4

Creates a dummy policy.

```APIDOC
## POST /policies/dummy/

### Description
Creates a dummy policy.

### Method
POST

### Endpoint
/policies/dummy/
```

--------------------------------

### Install Optional Packages for SSH/Local Login on Debian-based Systems

Source: https://docs.goauthentik.io/endpoint-devices/authentik-agent/agent-deployment/linux

Installs optional packages required for SSH server authentication and local device login.

```bash
sudo apt install libnss-authentik libpam-authentik
```

--------------------------------

### POST /outposts/instances/

Source: https://docs.goauthentik.io/releases/2024.4

Creates a new outpost instance.

```APIDOC
## POST /outposts/instances/

### Description
Creates a new outpost instance.

### Method
POST

### Endpoint
/outposts/instances/

### Request Body
- **type** (string)

### Response
#### Success Response (201 Created)
- **type** (string)

### Request Example
```json
{
  "type": "string"
}
```

### Response Example
```json
{
  "type": "string"
}
```
```

--------------------------------

### Install macOS Dependencies with Homebrew

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Installs native dependencies required for development on macOS using Homebrew. You can modify the command to skip packages you already have.

```bash
brew install \
libxmlsec1 \
libpq \
pkg-config \
uv \
postgresql \
node@24 \
golangci-lint \
ষুধ 
krb5 \
cmake
```

--------------------------------

### Download Template File

Source: https://docs.goauthentik.io/developer-docs/docs/templates/combo

Use this command to download the `combo.tmpl.md` template file from the authentik GitHub repository.

```bash
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/docs/developer-docs/docs/templates/combo.tmpl.md
```

--------------------------------

### GET /admin/system/

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves system information, including version validation status.

```APIDOC
## GET /admin/system/

### Description
Retrieves system information.

### Method
GET

### Endpoint
/admin/system/

### Response
#### Success Response (200)
- **version_latest_valid** (boolean) - Check if latest version is valid
```

--------------------------------

### Download Procedural Template

Source: https://docs.goauthentik.io/developer-docs/docs/templates/procedural

Use this command to download the procedural template file from the GitHub repository.

```bash
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/docs/developer-docs/docs/templates/procedural.tmpl.md
```

--------------------------------

### SCIM User Payload Example

Source: https://docs.goauthentik.io/users-sources/sources/protocols/scim

This is an example of a SCIM request payload for user creation or update. It includes core user attributes and an enterprise extension.

```json
{
    "schemas": [
        "urn:scim:schemas:core:2.0",
        "urn:scim:schemas:extension:enterprise:2.0"
    ],
    "userName": "foo.bar",
    "name": {
        "familyName": "bar",
        "givenName": "foo",
        "formatted": "foo.bar"
    },
    "emails": [
        {
            "value": "foo.bar@authentik.company",
            "type": "work",
            "primary": true
        }
    ],
    "title": "",
    "urn:scim:schemas:extension:enterprise:2.0": {
        "department": ""
    }
}
```

--------------------------------

### Example File Path to URL Conversion

Source: https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Illustrates how a file path in the repository is converted into a public URL for the documentation site. The `website/docs` prefix and file extensions are removed, and a trailing slash is added.

```text
/website/docs/developer-docs/docs/style-guide.mdx
```

```text
https://docs.goauthentik.io/developer-docs/docs/style-guide/
```

--------------------------------

### Restore Database Content

Source: https://docs.goauthentik.io/troubleshooting/postgres/upgrade_kubernetes

Connect to the PostgreSQL pod, navigate to the directory, verify the dump file, set the password, and import the database dump.

```bash
# Navigate to the PostgreSQL directory  
cd /bitnami/postgresql/  

# Verify your dump file is still there  
ls -lh dump.sql  

# Set the PostgreSQL password  
export PGPASSWORD=$(cat $POSTGRES_PASSWORD_FILE)  

# Import the database dump  
psql -U $POSTGRES_USER $POSTGRES_DATABASE < dump.sql
```

--------------------------------

### Example OAuth Claims Data

Source: https://docs.goauthentik.io/users-sources/sources/protocols/oauth

This JSON object represents example claims that might be returned by an OAuth source, used within authentik's property mappings.

```json
{
    "iss": "https://source.company",
    "sub": "f153e7da687eec8c8789c72b6cc6bb5197df7b48b263b3151f36908e1bc10691",
    "aud": "01e4DmQiG1d3kaewD3Mkz7E7kXknk9j43eZMkNaE",
    "aud": "a7809c1b1c4aaa50adfb68660a6273dd9c8d15e4",
    "email": "user@authentik.company",
    "email_verified": True,
    "name": "User",
    "given_name": "User",
    "preferred_username": "user",
    "nickname": "user",
}

```

--------------------------------

### Download Integration Template

Source: https://docs.goauthentik.io/developer-docs/docs/templates

Use this command to download the `service.md` template for documenting new integrations. This template is part of the official GitHub repository.

```bash
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/template/service.md  
```

--------------------------------

### Invitation Token URL Example

Source: https://docs.goauthentik.io/add-secure-apps/flows-stages/stages/invitation

Users can initiate an enrollment flow with an invitation token by appending the 'itoken' parameter to the flow URL.

```url
https://authentik.example/if/flow/your-enrollment-flow/?itoken=invitation-token
```

--------------------------------

### Example IdP Metadata

Source: https://docs.goauthentik.io/users-sources/sources/protocols/saml

This is an example of Identity Provider (IdP) metadata in XML format. It contains information such as the Entity ID, Single Sign-On service endpoints, and contact details.

```xml
<md:EntityDescriptor entityID="https://saml.company/idp">

    <md:IDPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" WantAuthnRequestsSigned="false">

        <md:NameIDFormat>

            urn:oasis:names:tc:SAML:2.0:nameid-format:persistent

        </md:NameIDFormat>

        <md:NameIDFormat>

            urn:oasis:names:tc:SAML:2.0:nameid-format:transient

        </md:NameIDFormat>

        <md:NameIDFormat>

            urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

        </md:NameIDFormat>

        <md:NameIDFormat>

            urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

        </md:NameIDFormat>

        <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://saml.company/login/saml/"/>

        <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://saml.company/login/saml/"/>

    </md:IDPSSODescriptor>

    <md:Organization>

        <md:OrganizationName xml:lang="en">Example Organization</md:OrganizationName>

        <md:OrganizationDisplayName xml:lang="en">Example Organization</md:OrganizationDisplayName>

        <md:OrganizationURL xml:lang="en">http://www.company</md:OrganizationURL>

    </md:Organization>

    <md:ContactPerson contactType="technical">

        <md:Company>Example Organization</md:Company>

        <md:GivenName>John</md:GivenName>

        <md:SurName>Doe</md:SurName>

        <md:EmailAddress>john.doe@company</md:EmailAddress>

        <md:TelephoneNumber>012 345 67890</md:TelephoneNumber>

    </md:ContactPerson>

    <md:ContactPerson contactType="support">

        <md:Company>Example Organization</md:Company>

        <md:GivenName>Helpdesk</md:GivenName>

        <md:SurName>Support</md:SurName>

        <md:EmailAddress>helpdesk@company</md:EmailAddress>

        <md:TelephoneNumber>012 345 67890</md:TelephoneNumber>

    </md:ContactPerson>

</md:EntityDescriptor>
```

--------------------------------

### Generate API Documentation

Source: https://docs.goauthentik.io/developer-docs/setup/full-dev-environment

Run this command to generate updated API documentation. This is a required step before submitting a pull request.

```bash
make gen
```

--------------------------------

### Pull Images and Start PostgreSQL

Source: https://docs.goauthentik.io/troubleshooting/postgres/upgrade_docker

Pulls the latest Docker images and starts only the PostgreSQL service, forcing recreation if necessary. 'network_mode: none' should be temporarily added to the PostgreSQL service in compose.yml before this step.

```bash
docker compose pull
```

```bash
docker compose up --force-recreate -d postgresql
```

--------------------------------

### Build Integrations Documentation

Source: https://docs.goauthentik.io/developer-docs/docs/writing-documentation

Builds the integrations documentation locally. This command combines linting and building, and should be run before committing changes to ensure linter errors do not prevent build checks from passing.

```bash
make integrations
```

--------------------------------

### Get All Authenticators

Source: https://docs.goauthentik.io/releases/2024.4

Retrieves all authenticators.

```APIDOC
## GET /authenticators/all/

### Description
Retrieves all authenticators.

### Method
GET

### Endpoint
/authenticators/all/
```

--------------------------------

### GET /policies/all/

Source: https://docs.goauthentik.io/releases/2025.8

Retrieves all policies.

```APIDOC
## GET /policies/all/

### Description
Retrieves all policies.

### Method
GET

### Endpoint
/policies/all/

### Parameters
#### Query Parameters
- **autocomplete** (object) - Optional - Autocomplete parameters for filtering.

### Response
#### Success Response (200 OK)
- **autocomplete** (object) - Autocomplete suggestions.
```