benschubert.infrastructure.authentik_application module – Allows administration of Authentik applications

Note

This module is part of the benschubert.infrastructure collection (version 0.0.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install benschubert.infrastructure.

To use it in a playbook, specify: benschubert.infrastructure.authentik_application.

Synopsis

Parameters

Parameter

Comments

application

dictionary / required

The configuration for the specified application

group

string

The group in which to add the application on the Authentik UI

meta_description

string

The description of the application

name

string / required

The name of the application

open_in_new_tab

boolean

Whether the application should be opened in a new tab in the main application list

Choices:

  • false ← (default)

  • true

provider

integer / required

The id of the provider assigned to the application

slug

string / required

The slug used as a unique id for the application

authentik_token

string / required

The token used to authenticate against the Authentik server

authentik_url

string / required

The URL at which to contact the Authentik server

ca_path

string

PEM formatted file that contains a CA certificate to be used for validation

state

string

Whether the entity should exist or not

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

The timeout to set when contacting the Authentik Server.

If your server is slow to respond, it might be necessary to bump this

Default: 10

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to false used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Examples

- name: Configure an application for Traefik's dashboard
  benschubert.infrastructure.authentik_application:
    authentik_token: <my-secret-token>
    authentik_url: https://authentik.test/
    application:
      name: Traefik's dashboard
      slug: traefik-dashboard
      provider: 1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

data

dictionary

The information returned by the Authentik API

Returned: always

Sample: {"group": "", "launch_url": "https://traefik.test/", "name": "Traefik's dashboard", "open_in_new_tab": false, "pk": "<pk>", "provider": 1, "provider_obj": "<...>", "slug": "traefik-dashboard"}

Authors

  • Benjamin Schubert (@benjaminschubert)