Skip to main content

User write stage

The User Write stage writes data from the current flow context into a user object.

Overview​

This stage updates the current pending_user, or creates a new user if the flow does not already have one and the configured creation mode allows it.

It is commonly used in enrollment, recovery, and profile-update flows after a Prompt stage has collected input into prompt_data.

Configuration options​

  • User creation mode: control whether the stage never creates users, creates them only when required, or always creates them.
  • Create users as inactive: mark newly created users as inactive.
  • Create users group: optionally add newly created users to a specific group.
  • User type: select the user type for newly created users: Internal, External, or Service Account.
  • User path template: optionally set the path new users will be created under. If left blank, the default path will be used.

Flow integration​

Use this stage after one or more stages that populate flow context, usually a Identification stage, Prompt stage, or Email stage.

In enrollment flows, this stage is often followed by a User Login stage so the newly created user is immediately signed in.

Notes​

Dynamic groups​

To add users to dynamic groups, set groups in the flow plan context before this stage runs. The value must be a list of actual Group objects:

from authentik.core.models import Group

group, _ = Group.objects.get_or_create(name="some-group")
request.context["flow_plan"].context["groups"] = [group]
return True