FunctionCopy link to clipboard
isusernametaken( username )
Verifies whether a user account with the specified username is already present.
See also: Create a New User, Add User Smart Service
ParametersCopy link to clipboard
| Keyword | Type | Description |
|---|---|---|
|
|
Text |
The username to check against the current list of active and deactivated users. |
Usage considerationsCopy link to clipboard
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.
ExamplesCopy link to clipboard
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")
Copy
Returns true.
1
isusernametaken("John.Doe")
Copy
Returns false due to case sensitivity.
Feature compatibilityCopy link to clipboard
The table below lists this function's compatibility with various features in Appian.
| Feature | Compatibility | Note |
|---|---|---|
| Portals | Partially compatible | Can be used with Appian Portals if it is connected using an integration and web API. |
| Offline Mobile | Partially compatible | Can be used with offline mobile if it is loaded at the top of the form. |
| Sync-Time Custom Record Fields | Incompatible | |
| Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
| Process Reports | Compatible | |
| Process Events | Compatible |