---
title: "create user · RUAL Documentation"
description: "create a new user in your cluster"
canonical: https://docs.rual.nl/block-types/users/function_user_create
language: en
---

# create user

This block is part of the [`users`](https://docs.rual.nl/block-types/users) group and was last modified in core [`v14.0.4`](https://docs.rual.nl/core-versions/140004).

create a new user in your cluster

- flow `flow`

- User ID required `value` The ID of the user (eg: username, email, code)

- Password required `value` Password or passcode for the user

- User Data `mutations` Optional: Extra data for the user account

- expiry `date` The user will be removed after this date

- username sanitize `v13.0.8` `condition` If true all special characters (Besides _,-,+,@,.) will be removed from the username.

- allow login as `v14.0.4` `condition` Allow admins to sign in as this user without their password

- allow passwordless login `v14.0.4` `condition` Allow this user to sign in without a password (only for non-admin users)

- flow `flow`

- User `object`

- success `v10.4.29` `condition` Returns false in case of an error

- error `v10.4.29` `value` Return the error in case of an error

A typical wiring for [create user](https://docs.rual.nl/block-types/users/function_user_create): [true](https://docs.rual.nl/block-types/condition/condition_is_true) feeds the `username_sanitize` pin; [branch](https://docs.rual.nl/block-types/flow/branch) feeds the `flow` pin; [set fields](https://docs.rual.nl/block-types/mutations/mutations_set_bp_field_multiple) feeds the `mutations` pin; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `user_id` pin; [value](https://docs.rual.nl/block-types/value/value_default) feeds the `password` pin; the `flow` out pin feeds [branch](https://docs.rual.nl/block-types/flow/branch); the `error` out pin feeds [log](https://docs.rual.nl/block-types/logging/function_console_log); the function out pin wires to an [execute](https://docs.rual.nl/block-types/function%20execution/function_custom_execute_from_trigger) block.

![Studio canvas example for the create user block: typical wiring for create user.](https://docs.rual.nl/canvas-examples/function_user_create.png)

### Commonly used with

In production blueprints, this block is most often wired together with:

- [branch](https://docs.rual.nl/block-types/flow/branch): wired in both directions with this block.

- [true](https://docs.rual.nl/block-types/condition/condition_is_true): feeds into this block. Gives the condition true hard-coded.

- [log](https://docs.rual.nl/block-types/logging/function_console_log): this block feeds into it.

- [set fields](https://docs.rual.nl/block-types/mutations/mutations_set_bp_field_multiple): feeds into this block. Generates an array of mutations based on the given filled fields.

- [get fields](https://docs.rual.nl/block-types/object/object_field_getter_multiple): this block feeds into it. Gets the selected fields from the given object.

- [new object](https://docs.rual.nl/block-types/object/object_new_fields): this block feeds into it. Builds a new object filled with the given fields.

### Version history

Introduced in [`v14.0.4`](https://docs.rual.nl/core-versions/140004).