benschubert.infrastructure.authentik_outpost_provider module – Allows connecting Authentik providers to outposts

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_outpost_provider.

Synopsis

Parameters

Parameter

Comments

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

outpost_name

string / required

The name of the outpost that should handle the given provider

provider_pk

integer / required

The private key of the provider to configure

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 the traefik provider to use the builtin outpost
  benschubert.infrastructure.authentik_outpost_provider:
    authentik_token: <my-secret-token>
    authentik_url: https://authentik.test/
    outpost_name: authentik Embedded Outpost
    provider_pk: <pk>

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 for the outpost

Returned: always

Sample: {"config": {"authentik_host": "https://authentik.test"}, "name": "authentik Embedded Outpost", "pk": "<pk>", "providers": [1], "providers_obj": "<...>", "type": "proxy"}

Authors

  • Benjamin Schubert (@benjaminschubert)