Unique username

Question

Hi,

I am looking for a solution which checks if the username ist unique with the following requirements:

If [first letter of first name].[last name]

is not possible as username then

1. Try full name:

[first name].[last name]

if not possbile try

2. middle name:

[first name].[other given name].[last name]

if not possbile try

3. last name only:

[last name]

if not possbile try

4. add number

[first letter of first name].[last name]2

I' am looking forward to a hint. Thanks

Answer 1

Hello Boris,

Have a look at the following tutorial: https://www.adaxes.com/help/ValidateModifyUserInputWithScript. Also, the following script from our repository might be helpful: https://www.adaxes.com/script-repository/automatically-add-a-digit-to-the-username-if-it-is-not-unique-s298.htm. If you face issues writing the script yourself, please, specify the following:

• What exactly do you mean by add number? Should it be done once or until the username becomes unique?
• What should be done if a unique username cannot be formed?

Any additional details will be much appreciated.

Comments

Thanks for helping me! I've tried the tutorial but I'am not able to catch all 4 cases in a script.

The script should try the 4 alternative naming steps, one after the other, until the name becomes unique. If also step 4 is not possible then it should count up until the name gets unique:

[first letter of first name].[last name]2 [first letter of first name].[last name]3 [first letter of first name].[last name]4 .....

---

Hello Boris,

We will gladly help you with the script. In step 2 you specified middle name [first name].[other given name].[last name]. The template looks incorrect as first name and given name is the same thing. Should it be [first name].[initials].[last name]?

---

Sorry for the misunderstanding. It should be middle name

Thanks!

---

Hello Boris,

Thank you for specifying. You can use the below script:

function IsUserNameUnique($username)
{
    $domain = $Context.GetObjectDomain("%distinguishedName%")
    $user = Get-AdmUser -Filter {sAMAccountName -eq $username} -Server $domain -AdaxesService localhost
    return $null -eq $user
}

function UpdateUser($username, $domain)
{
    $userPrincipalName = $username + $domain
    $Context.SetModifiedPropertyValue("sAMAccountName", $username)
    $Context.SetModifiedPropertyValue("userPrincipalName", $userPrincipalName)
}

# Get initial values
$username = $Context.GetModifiedPropertyValue("samAccountName")

# Check initial username for uniqueness
$usernameIsUnique = IsUserNameUnique $username
if ($usernameIsUnique)
{
    return
}

# Get domain part for UPN
$userPrincipalName = $Context.GetModifiedPropertyValue("userPrincipalName")
$localPart, $domainPart = $userPrincipalName.Split("@")
$domainPart = "@" + $domainPart

# Check second appoach
$username = "%firstname:lower%.%lastname:lower%"
$usernameIsUnique = IsUserNameUnique $username
if ($usernameIsUnique)
{
    UpdateUser $username $domainPart
    return
}

# Check third appoach
$username = "%firstname:lower%.%middleName:lower%.%lastname:lower%"
$usernameIsUnique = IsUserNameUnique $username
if ($usernameIsUnique)
{
    UpdateUser $username $domainPart
    return
}

# Check fourth appoach
$username = "%lastname:lower%"
$usernameIsUnique = IsUserNameUnique $username
if ($usernameIsUnique)
{
    UpdateUser $username $domainPart
    return
}

# If the username is not unique, add a digit to it.
$uniqueUsername = "%firstname:lower,1%.%lastname:lower%"
for ($i = 1;; $i++)
{
    $uniqueUsername = $uniqueUsername + $i
    if (IsUserNameUnique $uniqueUsername)
    {
        UpdateUser $uniqueUsername $domainPart
        break
    }
}

---

Thanks a lot for the script, works as expected! Great!

---

I have a follow-up question about this, what do I set as a variable in the RemoteRoutingAdressTemplate. So far I had entered here

%firstname:lower,1%.%lastname:lower%@$tenantname.mail.onmicrosoft.com"

Thanks

---

Hello Boris,

Sorry for the confusion, but we are not sure what exactly your question is about. There is no such variable in the script.

---

Sorry for the misunderstanding, I am talking about the RemoteRoutingAddress here:

$addressTemplate = %firstname:lower,1%.%lastname:lower%@$tenantname.mail.onmicrosoft.com"

https://www.adaxes.com/help/EnablingDisablingRemoteMailboxes/#change-remote-routing-address-template

---

Hello Boris,

Thank you for clarifying. That is where you need to specify a template for the remote routing address that will be used to automatically enable remote mailboxes. As it is mentioned in the variable description, you can use value references in the template. For each user they will resolve into the corresponding values of their account.

---

Thanks, but if we have the case the username was not uniqe and the script above changes the username to:

$uniqueUsername ="%firstname:lower%.%middleName:lower%.%lastname:lower%"

I also need this unique username as new variable for the remote routing adress template.

How can I catch this?

---

Hello Boris,

You can use the following approach:

$addressTemplate = %username%@company.mail.onmicrosoft.com"

As the script for unique username generation is executed before users are created, the value reference will result into the final username the account is actually created with.

---

OK now I get it, thanks.

---

It's not often that the script is used, so I'm just getting back to you. In case of the change to "%firstname:lower%.%lastname:lower%" (2nd approach) there is always the problem that the following business rules don't work anymore, because the UPN is then always "firstname.lastname@" without domain ending
In this case there seems to be an error in the script, can you reproduce this?****

---

Hello Boris,

Sorry for the confusion, but with the current screenshot we are not able to provide any insight on the issue. If you cannot post an uncovered screenshot here, please, send it to us at support@adaxes.com. Also, please, send a screenshot of the business rule itself.

Additionally, please, specify the version of Adaxes you are currently using (including the build number). For details on how to check it, see https://www.adaxes.com/help/CheckServiceVersion.

---

Hello Boris,

Thank you for the provided details. Unfortunately, there was a mistake in the script. To fix it, replace this line in the script

$localPart, $domainPart = $username.Split("@")

with the below one

$localPart, $domainPart = $userPrincipalName.Split("@")

We also update the script in the above post as well.