AuthentikInstall

Summary

Update an existing user in Authentik by specifying the user's unique ID and any fields to change.

Inputs

• User ID (required) — The unique integer ID (primary key) of the user to update.
• Username — New username for the user (1-150 characters); leave empty to keep current.
• Name — New display name for the user; leave empty to keep current.
• Email — New email address for the user (optional, max 254 characters).
• Is Active — Boolean flag to set whether the user account is active.
• Additional Fields — Optional additional fields including:
• Groups: Comma-separated list of group UUIDs to assign to the user.
• Path: User path in Authentik (minimum 1 character if provided).
• User Type: Account type, one of internal, external, service_account, or internal_service_account.
• Attributes: Key-value pairs of custom attributes for the user.

Output shape

a JSON object representing the updated user record as returned by Authentik's API

If validation errors occur (e.g., invalid User ID, wrong UUID format in groups, or field length violations), the operation throws an error. The update is performed via a PATCH request to /core/users/{userId}/. Only provided fields are changed; fields left empty are not modified.

Examples

Example 1: Update user with ID 5 to have a new username and mark as inactive

User ID=5, Username='newname', Is Active=false

Example 2: Update user attributes and assign groups

User ID=10, Additional Fields.Groups='550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8', Additional Fields.Attributes with keys and values