Skip to main content

​
Intro

The User Management tool automates creating and updating users in your Domo instance, including remote instances that you manage, using a configuration DataSet. You can also use the configuration DataSet to define attributes for instance members in bulk. Learn more about attributes in Domo. This article describes how to access the User Management tool, create your configuration DataSet, including attributes, and create jobs in the tool to perform your desired tasks.

​
Required Grants

User Management is part of the Governance Toolkit. To access the toolkit, the following grants must be enabled for your role:
  • Create Custom Pipeline Processes — Allows an individual to create, update, share, and delete jobs. Grant holders can only view jobs that they created or jobs that have been shared with them.
  • Edit DataSets — Allows an individual to create and edit DataSets to which they have access.
  • Manage All Users — Allows an individual to create, edit, and delete any user and reset their password.
  • Add New People — Allows an individual to add new people to Domo.
  • (Admin-level) Manage All Roles — Allows an individual to create, edit, and delete custom roles, and assign anyone to any role in the instance.
Learn how to manage roles and grants.

​
Access User Management

Follow these steps to access User Management in the Governance Toolkit:
  1. Navigate to Admin > Governance > Governance toolkit.
  2. Go to User Management.
    Note: If you are missing the Governance Toolkit or User Management option, confirm that your role has the required grants . To enable the toolkit for your Domo account, contact your account team.

​
Create the Configuration DataSet

You must create a configuration DataSet for User Management. It should match the formatting of the Bulk Import feature found in the Governance Admin Settings (Admin > Governance > People). An example import file is available there. Learn more about bulk importing.
Important: For the configuration DataSet, “On-Demand” DataSet Views are not supported. Only Views that update on a schedule or via DataSet update are allowed.
This table lists all of the required fields for the configuration DataSet:
Column Header Type Format
displayName String John Smith

roleId

As with all other fields listed in this table, roleId is required.

Number

Valid roleId values include:

  • 1 (Admin)
  • 2 (Privileged)
  • 3 (Editor)
  • 4 (Participant)
  • 5 (Social)

Note: If the Custom Role feature is enabled for your instance, you can also enter a user’s custom Role ID.

Find the Role ID by going to Admin > Governance > Roles . Select the role from the list and go to the Details tab. Locate the Role ID.

non cloud admin.jpg

title String Software Engineer
department String Development
email Email johnsmith @ example. com
alternateEmail Email john_smith @ example. com
phoneNumber International phone number Example: (800) 899-1000
deskPhoneNumber International phone number Example: (800) 899-1000
employeeNumber Number — Long or integer 0074
location String

Utah

timeZone String

Example: America/Denver

See this Wikipedia article for a list of the tz database time zones .

locale Locale language tag

Valid locale values include:

de-DE, de-AT, de-CH, en-AU, en-CA, en-150, en-HK, en-IE, en-IL, en-MO, en-NZ, en-SG, en-GB, en-US, en-001, es-ES, es-US, es-419, es-MX, fr-BE, fr-CA, fr-FR, fr-CH, nl-BE, nl-NL, pt-BR, pt-PT, ja-JP, zh-CN, zh-Hans-HK, zh-Hans-MO, zh-Hans-SG

employeeId String

UT000034065

​
Create a Job

Follow these steps to create a job:
  1. Access User Management.
  2. Select + New Job.
  3. Provide the following information: Note: The fields marked with an asterisk (*) are required.
    • Job name *
    • Job description
    • Configuration DataSet * Learn how to create your configuration DataSet above.
    • Send invite — Checking this box sends an email to all newly created users.
    • Delete orphaned users — Warning: This deletes any person in your instance who is not included in the configuration DataSet.
    • Where would you like to run this job? — Choose whether to run this job in the current instance or a remote instance you manage.
    • Where would you like to save run logs? — Each job keeps track of executions for the job and surrounding information. You can either select a new DataSet or an existing DataSet to save run logs.
      • New DataSet — If this is selected, a new DataSet is created in your Domo instance and all job runs are written to the new DataSet.
      • Existing DataSet — If this is selected, the selected existing DataSet allows you to combine multiple User Management jobs into a single logging DataSet. The DataSet must be created by the User Management tool. The DataSet must also already contain rows of data.
    • Email(s) to receive notifications — You can add individual emails to this field. Each recipient receives an email notification from Domo each time the job runs. The notification outlines what actions the job performed during the run and documents any failures.
  4. Submit your changes. IMAGE

​
Run a Job

When running a job, you can choose to enable it by toggling the Disabled/Active switch. Enabling allows the job to run on a schedule.
  • When the toggle is Disabled, the job must always be executed manually.
  • When the toggle is Active, the job executes every six hours and every time the configuration DataSet is updated.
Follow these steps to run a job manually:
  1. Access User Management.
  2. Hover over the job you want to run and select Options > Run Job.

​
Manage Attributes With the Configuration DataSet

You can use the User Management configuration DataSet to help create and manage system and custom attributes in your instance in bulk.
What are attributes? Attributes drive group membership and personalized data permissions (PDP) within Domo. System attributes are included with Domo by default; when you create the configuration DataSet as described above , the system attributes are included. Custom attributes are created by Domo users, including being sourced from your IdP (identity provider). Learn more about attributes .

​
Add Custom Attributes With the Configuration DataSet

When you create a custom attribute from the Attributes page in the Governance Admin Settings (Admin > Governance > Attributes), you must provide a Key value. Domo looks for this key when authenticating users. Learn more about attributes.
When you use User Management to create or update custom attributes, you must include the matching Key for each attribute in the configuration DataSet. How does this work? Follow the steps below.
  1. Add a < custom attribute > column for each custom attribute to the configuration DataSet, where the column name is the custom attribute’s Key. For example, to add the Team ID attribute where the Key is teamId, add a new column to the configuration DataSet called teamId.
  2. Fill in the column with the values for each individual. The data type of the attribute value must match the data type of the column. For example, if the attribute expects a number, but the configuration DataSet includes letters, the User Management job will not run successfully. For example, the data type is string and the value for each individual is sales.
    Note: List-type custom attributes are also supported, and can be delimited with a | (pipe) character. For example, abc|def adds both abc and def as values to a single custom list attribute.
  3. Save the configuration DataSet and re-upload it to Domo.
  4. Access User Management and navigate to your existing job.
  5. Select Edit to make changes.
  6. Choose your updated DataSet in the Configuration Dataset dropdown.
  7. Submit your changes and run the job.

​
View Custom Attributes

After adding custom attributes through your configuration DataSet, you can check that they were configured correctly by viewing the profile page for a person or group included in the configuration DataSet (Admin > Governance > People > << user>>). Under Custom, the user/group’s custom attributes and their values are listed.
Screenshot 2024-06-06 at 10.03.13 AM.png

​
Remote Instance Configuration

With remote instance configuration, you can be in one Domo instance and manage individuals in other instances you have access to. You can manage individuals remotely by setting up the configuration DataSet. Configure the Domo Access Token account with either a Domo Access token or a username and password for the remote instance.

​
Configure User Management for Remote Instance

You can also configure your User Management setting for any remote instances you have access to. Follow the steps below to configure User Management for a remote instance:
  1. While creating or editing a job, under Configuration, select a configuration DataSet. This DataSet should be populated with valid values for the remote instance according to User Management guidelines given above.
  2. Under Where would you like to run this job? select Remote Instance.
  3. In the Instance: field, enter the domain for the remote instance you want to manage PDP for. The domain format must be example.domo.com.
  4. Use the Select the account for your instance: dropdown to select a valid Domo Access Account. Learn how to configure a Domo Access Token Account below.
  5. Choose where to save run logs under Reporting. Note: The notification emails and metric logs are written to the instance the policy is running from, not to the remote instance.
  6. Select Submit to save your changes.

​
Configure a Domo Access Token Account

Follow these steps to configure a Domo Access Token account:
  1. In Domo, navigate to Accounts.
  2. Select Add New > Account and use the dropdown to choose a Domo Access Token account.
  3. In the modal, complete one of the following options:
    • Access Token — Enter an access token in the Remote Instance Access Token field.
    • Username and password — Enter your credentials in the Remote Instance Username and Remote Instance Password fields.
  4. Select Connect.

​
Generate an Access Token

Follow these steps to generate an access token:
  1. Navigate to Admin > Authentication > Access tokens.
  2. On the Access tokens page, select + Generate access token.
  3. Enter a description in the Access token description field.
  4. Search for and select a user for whom you are generating the access token.
  5. Select an expiration interval in the Expire after list.
  6. Select Generate.
  7. Copy the code to use.