benschubert.infrastructure.authentik_user module – Allows administration of Authentik users

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

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

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

user

dictionary / required

The configuration for the specified user

name

string / required

The “display” name of the user

path

string

The path under which to keep the user in Authentik, for organization purpose

Default: "users"

type

string

The type of user that is created

Choices:

  • "internal" ← (default)

  • "service_account"

username

string / required

The username of the user, used to login, and find the user.

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: Create a user named 'testuser'
  benschubert.infrastructure.authentik_user:
    authentik_token: <my-secret-token>
    authentik_url: https://authentik.test/
    user:
      name: Test User
      username: testuser

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: {"is_superuser": false, "name": "Test User", "type": "internal", "username": "testuser"}

Authors

  • Benjamin Schubert (@benjaminschubert)