authentik
App · 17 actions
Run IT on- and offboarding in authentik: create, update, deactivate and find users, manage groups, send recovery links and invitations, and start a workflow on a new user, a deactivation or a security event.
Actions
| Action | What it does |
|---|---|
| Add user to group | Put a user in a group, which gives them its access. |
| Create group | Create a group, on its own or inside another one, such as one per team or project. |
| Create invitation | Make an invitation link that lets someone create their own account through an enrollment flow, and have authentik email it to them if you like. |
| Create recovery link | Make a link that lets a user set a new password, such as for a new starter or someone locked out, to send them yourself. |
| Create user | Create a user when someone joins, such as from an HR system or a form, with their name, email, groups and attributes. |
| Deactivate user | Stop a user signing in, such as when they leave, and end their sessions. |
| Delete group | Delete a group. |
| Delete invitation | Withdraw an invitation, so its link stops working. |
| Delete user | Delete a user for good. |
| Find events | Find events in authentik's log, newest first, such as failed logins or password changes since yesterday, for one user or everyone. |
| Find users | Find users by words in their name, username or email, by exact email or username, by group, or by whether they're active, such as everyone in a group. |
| Get user | Get a user's details and groups by their username, email address or ID. |
| List groups | List groups with their IDs, parent groups and member counts, and their members' usernames if you ask for them. |
| Reactivate user | Let a deactivated user sign in again. |
| Remove user from group | Take a user out of a group. |
| Send recovery email | Have authentik email a user a link to set a new password, using an email stage of its recovery flow. |
| Update user | Change a user's name, username, email, attributes or folder. |
Add user to group
Put a user in a group, which gives them its access. Someone already in it stays in it.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
- Group
grouptextRequired - The group, by name or ID.
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
changedtrue/false- Whether this step changed anything, or it was already so
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
grouptext- The group's name
group_idtext- The group's ID
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
Example output
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"changed": true,
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group": "Engineering",
"group_id": "4c5804e3-d659-471c-be25-b2a36ee2c83d",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10"
}Create group
Create a group, on its own or inside another one, such as one per team or project.
Inputs
- Name
nametextRequired - The group's name.
- Parent group
parenttext - Put it inside this group, so its members get the parent's access too.
- Attributes
attributesobject - Extra details as a JSON object, such as {"cost_center": "R&D"}.
Outputs
attributesobject- Its attributes
idtext- The group's ID
linktext- A link to it in authentik's admin interface
member_countnumber- How many users are in it directly
memberslist- Its members' usernames, when asked for
nametext- Its name
parent_idslist- The IDs of the groups it's inside
parentslist- The names of the groups it's inside
superusertrue/false- Whether it makes its members superusers
Example output
{
"attributes": {
"cost_center": "R&D"
},
"id": "4c5804e3-d659-471c-be25-b2a36ee2c83d",
"link": "https://auth.example.com/if/admin/#/identity/groups/4c5804e3-d659-471c-be25-b2a36ee2c83d",
"member_count": 2,
"members": [
"alice",
"jane.doe"
],
"name": "Engineering",
"parent_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7"
],
"parents": [
"Staff"
],
"superuser": false
}Create invitation
Make an invitation link that lets someone create their own account through an enrollment flow, and have authentik email it to them if you like.
Inputs
- Enrollment flow
flowtextRequired - The flow the link opens. It needs an invitation stage for the invitation to count.
- Name
nametext - A name to tell it apart, such as the person's name. Letters, digits, - and _; other characters become -.
- Expires
expiresdate and time - When it stops working. Leave blank for never.
- Single use
single_usetrue/false - Delete it once someone has used it. On unless you turn it off.Default:
true. - Fixed data
fixed_dataobject - Values filled in for the person, as a JSON object such as {"email": "jane.doe@example.com", "name": "Jane Doe"}.
- Email it to
send_totext - Addresses authentik emails the link to, separated by commas.
Outputs
created_bytext- The username of who made it
emailed_tolist- The addresses authentik emailed it to
expirestext- When it stops working (ISO 8601); empty if never
fixed_dataobject- The values it fills in for the person
flowtext- The slug of the enrollment flow it opens
flow_nametext- That flow's name
idtext- The invitation's ID
linktext- The link to send the person
nametext- Its name
single_usetrue/false- Whether it is deleted once used
Example output
{
"created_by": "lodol",
"emailed_to": [
"jane.doe@example.com"
],
"expires": "2026-12-01T00:00:00Z",
"fixed_data": {
"email": "jane.doe@example.com"
},
"flow": "invitation-enrollment-flow-internal",
"flow_name": "Invitation enrollment",
"id": "077b0aed-4312-4def-85f9-15c2a0984feb",
"link": "https://auth.example.com/if/flow/invitation-enrollment-flow-internal/?itoken=077b0aed-4312-4def-85f9-15c2a0984feb",
"name": "jane-doe",
"single_use": true
}Create recovery link
Make a link that lets a user set a new password, such as for a new starter or someone locked out, to send them yourself. Needs a recovery flow set on the brand in authentik.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
- Valid for (hours)
valid_for_hoursnumber - How long the link works, in hours, up to 720 (30 days). Leave blank for authentik's default, which is a day unless an administrator changed it.From 1 to 720.
Outputs
emailtext- Their email address
linktext- The link that lets them set a new password
user_idnumber- The user's ID
usernametext- Their username
valid_for_hoursnumber- How many hours it was asked to last; 0 for authentik's default
Example output
{
"email": "jane.doe@example.com",
"link": "https://auth.example.com/if/flow/default-recovery-flow/?flow_token=8Hk2Qv0LZ9cTt4mWbX1yRr7pNe3sJd6aFg5uYo2iKl8",
"user_id": 42,
"username": "jane.doe",
"valid_for_hours": 24
}Create user
Create a user when someone joins, such as from an HR system or a form, with their name, email, groups and attributes. They have no password until they use a recovery link or an invitation.
Inputs
- Username
usernametextRequired - What they sign in with, such as jane.doe or their email address. 150 characters at most.
- Name
nametext - Their full name. Defaults to the username.
- Email
emailtext - Their email address.
- Groups
groupslist - Groups to put them in, by name or ID.
- Folder
pathtext - The folder under Directory > Users to put them in, such as users/contractors. Defaults to users.
- Attributes
attributesobject - Extra details as a JSON object, such as {"department": "Sales", "employee_id": "E-1042"}.
- Type
user_typetext - Internal for staff, external for customers and partners.One of:
internal,external. Default:internal.
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
Example output
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10"
}Deactivate user
Stop a user signing in, such as when they leave, and end their sessions. Can also take them out of every group. Their account and history are kept.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
- Remove from all groups
remove_from_groupstrue/false - Also take them out of every group they're in. The groups are listed in the result.
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
removed_from_groupslist- The groups they were taken out of; empty unless asked to
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
was_activetrue/false- Whether they were active before this step
Example output
{
"active": false,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group_ids": [],
"groups": [],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"removed_from_groups": [
"Staff",
"Engineering"
],
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10",
"was_active": true
}Delete group
Delete a group. Its members stay, without the group's access. A group that makes its members superusers isn't deleted.
Inputs
- Group
grouptextRequired - The group, by name or ID.
Outputs
deletedtrue/false- Always true
idtext- The deleted group's ID
nametext- Its name
Example output
{
"deleted": true,
"id": "4c5804e3-d659-471c-be25-b2a36ee2c83d",
"name": "Engineering"
}Delete invitation
Withdraw an invitation, so its link stops working.
Inputs
- Invitation
invitationtextRequired - The invitation's name, ID or link.
Outputs
deletedtrue/false- Always true
idtext- The deleted invitation's ID
nametext- Its name
Example output
{
"deleted": true,
"id": "077b0aed-4312-4def-85f9-15c2a0984feb",
"name": "jane-doe"
}Delete user
Delete a user for good. This can't be undone, and by default authentik also deletes their events from its log; deactivating keeps both.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
Outputs
deletedtrue/false- Always true
emailtext- Their email address
idnumber- The deleted user's ID
usernametext- Their username
Example output
{
"deleted": true,
"email": "jane.doe@example.com",
"id": 42,
"username": "jane.doe"
}Find events
Find events in authentik's log, newest first, such as failed logins or password changes since yesterday, for one user or everyone.
Inputs
- Event
eventtext - Which kind of event to find.One of:
any(Any event),login_failed(Failed login),login,logout,password_set(Password changed),mfa_added(Authenticator (MFA) added),user_write(User details written by a flow),suspicious_request(Suspicious request),impersonation_started(Impersonation started),invitation_used(Invitation used), and 9 more. Default:any. - Username
usernametext - Only events by or about the user with this username.
- Since
sincedate and time - Only events after this time.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
Outputs
countnumber- How many are listed
eventslist- The events, newest first
has_moretrue/false- Whether more events match than are listed
Example output
{
"count": 1,
"events": [
{
"action": "login_failed",
"action_name": "Failed login",
"app": "authentik.events.signals",
"attempted_username": "jane.doe",
"client_ip": "203.0.113.7",
"context": {
"password": "********",
"username": "jane.doe"
},
"created": "2026-11-06T18:21:00Z",
"id": "e8c76fa8-e25d-4d47-b277-76c454d69dc5",
"message": "",
"model_id": "",
"model_name": "",
"model_type": "",
"user_email": "jane.doe@example.com",
"user_id": 42,
"username": "jane.doe"
}
],
"has_more": false
}Find users
Find users by words in their name, username or email, by exact email or username, by group, or by whether they're active, such as everyone in a group.
Inputs
- Words
searchtext - Only users with these words in their username, name or email.
- Email
emailtext - Only the user with this email address, in any case.
- Username
usernametext - Only the user with this username, in any case.
- Group
grouptext - Only members of this group.
- Active or not
statustext - Which users to find.One of:
any(Both),active,inactive(Deactivated). Default:any. - Include service accounts
include_service_accountstrue/false - Also find accounts made for machines, such as the one Lodol uses.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
Outputs
countnumber- How many are listed
has_moretrue/false- Whether more users match than are listed
userslist- The users found, by username
Example output
{
"count": 1,
"has_more": false,
"users": [
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10"
}
]
}Get user
Get a user's details and groups by their username, email address or ID.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
Example output
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10"
}List groups
List groups with their IDs, parent groups and member counts, and their members' usernames if you ask for them.
Inputs
- Words
searchtext - Only groups with these words in their name.
- Include members
include_memberstrue/false - Also list each group's members by username.
- How many
limitnumber - The most to list. Defaults to 50.From 1 to 500.
Outputs
countnumber- How many are listed
groupslist- The groups, by name
has_moretrue/false- Whether more groups match than are listed
Example output
{
"count": 1,
"groups": [
{
"attributes": {
"cost_center": "R&D"
},
"id": "4c5804e3-d659-471c-be25-b2a36ee2c83d",
"link": "https://auth.example.com/if/admin/#/identity/groups/4c5804e3-d659-471c-be25-b2a36ee2c83d",
"member_count": 2,
"members": [
"alice",
"jane.doe"
],
"name": "Engineering",
"parent_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7"
],
"parents": [
"Staff"
],
"superuser": false
}
],
"has_more": false
}Reactivate user
Let a deactivated user sign in again.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
was_activetrue/false- Whether they were already active before this step
Example output
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10",
"was_active": false
}Remove user from group
Take a user out of a group. Someone not in it is left as they are.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
- Group
grouptextRequired - The group, by name or ID.
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
changedtrue/false- Whether this step changed anything, or it was already so
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
grouptext- The group's name
group_idtext- The group's ID
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
Example output
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"changed": true,
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group": "Engineering",
"group_id": "4c5804e3-d659-471c-be25-b2a36ee2c83d",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10"
}Send recovery email
Have authentik email a user a link to set a new password, using an email stage of its recovery flow.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
- Email stage
email_stagetext - The email stage that sends it. Leave blank for the one in a recovery flow.
- Valid for (hours)
valid_for_hoursnumber - How long the link works, in hours, up to 720 (30 days). Leave blank for authentik's default, which is a day unless an administrator changed it.From 1 to 720.
Outputs
email_stagetext- The email stage that sent it
sent_totext- The address the email went to
user_idnumber- The user's ID
usernametext- Their username
valid_for_hoursnumber- How many hours the link lasts; 0 for authentik's default
Example output
{
"email_stage": "default-recovery-email",
"sent_to": "jane.doe@example.com",
"user_id": 42,
"username": "jane.doe",
"valid_for_hours": 0
}Update user
Change a user's name, username, email, attributes or folder. Only what you fill in changes; attributes are added to theirs.
Inputs
- User
usertextRequired - The user's username, email address or ID (the number at the end of their link in authentik).
- Name
nametext - A new full name. Leave blank to keep it.
- New username
new_usernametext - A new username. Leave blank to keep it.
- Email
emailtext - A new email address. Leave blank to keep it.
- Attributes
attributesobject - Attributes to set, as a JSON object such as {"department": "Sales", "employee_id": "E-1042"}. The user's other attributes are kept; give one the value null to remove it.
- Folder
pathtext - Move them to this folder under Directory > Users, such as users/leavers. Leave blank to keep it.
Outputs
activetrue/false- Whether they can sign in
attributesobject- Their attributes, as authentik stores them
date_joinedtext- When the account was made (ISO 8601)
emailtext- Their email address; empty if none
group_idslist- The IDs of the groups they're in
groupslist- The names of the groups they're in
idnumber- The user's ID, as in their link in authentik
last_logintext- When they last signed in (ISO 8601); empty if never
last_updatedtext- When the account last changed (ISO 8601)
linktext- A link to them in authentik's admin interface
nametext- Their name
pathtext- The folder they're in under Directory > Users, such as users
superusertrue/false- Whether a group makes them a superuser
typetext- internal, external, service_account or internal_service_account
usernametext- Their username
uuidtext- The user's UUID
Example output
{
"active": true,
"attributes": {
"department": "Engineering",
"employee_id": "E-1042"
},
"date_joined": "2026-11-06T09:00:00Z",
"email": "jane.doe@example.com",
"group_ids": [
"c582dc6e-f705-4ad8-936e-45475f533dd7",
"4c5804e3-d659-471c-be25-b2a36ee2c83d"
],
"groups": [
"Staff",
"Engineering"
],
"id": 42,
"last_login": "",
"last_updated": "2026-11-06T09:00:00Z",
"link": "https://auth.example.com/if/admin/#/identity/users/42",
"name": "Jane Doe",
"path": "users",
"superuser": false,
"type": "internal",
"username": "jane.doe",
"uuid": "0f3c8b8e-6a51-4c5e-9a71-2f2d8c1e4b10"
}