Skip to main content

Account naming rules

Definition

Account naming rules define how to generate account names for target systems. The normal case is the account name will be the same as the user name, in other cases, here you could define the customized account name rules.

When you are configuring an agent, you have to indicate the user domain which will be used to create new accounts, that user domain refers to the Account naming rules defined on the Soffid console.

Screen overview

image.png

image.png

  • Agents: the account naming rule is selected for each of the agents.
  • Accounts: when creating an account, if no account name is specified, the system uses the naming rule to generate an account name.
  • Users: when we add an account, the naming rules indicate the generated name (which can be modified during the process). 

Standard attributes

  • Code: code used to identify the account naming rule.
  • Description: a brief description of the rule. That value will be displayed to select the user domain on the agent's setup.
  • User domain type: use to define the kind of 
    • Same as user name: use the main user name.
    • Assigned manually: the user will assign the account name.
    • Generated by script: allows you to configure the script condition and script creation of account naming.
  • Create account condition: defines the conditions to enable or prevent the creation of the account. It is only available when the "Generated by script" option is selected in the "User domain type".
  • Script: computes the name to assign to the user account. If the script returns null, the account is not going to be created. It is only available when the "Generated by script" option is selected in the "User domain type".

Actions

Table actions

Add new

Allows you to add a new account naming rule in the system. To add a new account naming rule it is necessary to fill in the required fields.

Delete user domain

Allows you to remove one or more account naming rules by selecting one or more records on the list.

Download CSV file

Allows you to download a CSV file with all the information about account naming rules. 

Import

Allows you to upload a CSV file with the account naming rules configuration to add new rules to the system.

First, you need to pick up a CSV file, that CSV has to contain a specific configuration. Then you need to check the contents. And finally, you need to select the mappings for each column of the CSV file to import the data correctly and click the Import button.

Account naming rules detail

Apply changes (disk button)

Allows you to save the account naming rule data.

Delete synchronization server

To delete a account naming rule you can click on the "three points" icon and then click the delete user domain button. Soffid will ask you for confirmation to perform that action, you could confirm or cancel the operation.

Undo

Allows you to undo any changes made.

Apply changes

Allows you to save the account naming rule data. Once you apply changes, the details page will be closed.

Others

Addins a new account

Create a new account naming rule.

image.png

Configure it in an agent.

image.png

In a user, add a new account for that agent.

image.png

Script examples

Condition

Only users with mail address in soffid.com can have an account:

"soffid.com".equals(user.mailDomain)

When the account name depends on other attribute

attributes.get("userCode")!=null && !attributes.get("userCode").isEmpty()

Script

Uses the email address as the account name

user.shortName+"@"+user.mailDomain

Username in uppercase

user.userName.toUpperCase()

When the account name depends on other attribute (check that it has a value in the condition)

attributes.get("userCode")