isusernametaken() Function

Function

isusernametaken( username )

Verifies whether a user account with the specified username is already present.

See also: Create a New User, Add User Smart Service

Parameters

Usage considerations

Returns a value of type Boolean.

A false result indicates that the username is available to use when creating a new user, unless the username contains special characters that are not permitted.

For a list of usernames, returning false means that all of the usernames are available. If any of the usernames are taken, the result will be true.

Both active and deactivated user accounts are referenced.

The username parameter is case-sensitive, however you will not be able to create a username if case-insensitive matches exist.

isusernametaken() cannot be used to define a column of process report data or in a process event.

Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

Given that you have users in your environment with the usernames john.doe and jane.doe:

1
isusernametaken("john.doe")

Returns true.

1
isusernametaken("John.Doe")

Returns false due to case sensitivity.

Feature compatibility

Feedback