benschubert.infrastructure.authentik_user_group module – Allows adding or removing users to groups in Authentik

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

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

group_pk

string / required

The pk for the group to add or remove the user from

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_pk

string / required

The pk of the user to add or remove to the group

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: Ensure the user with pk '123' is in the group '5'
  benschubert.infrastructure.user_group:
    authentik_token: <my-secret-token>
    authentik_url: https://authentik.test/
    group_pk: 5
    user_pk: 123

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 user

Returned: always

Sample: {"email": "<user-email>", "groups": ["<group1_pk>", "<group2_pk>"], "is_superuser": false, "pk": "<user-pk>", "username": "<user>"}

Authors

  • Benjamin Schubert (@benjaminschubert)