> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Group Management

export const InlineImage = ({src, alt = '', height = '1.6em'}) => {
  return <img noZoom src={src} alt={alt} style={{
    display: 'inline',
    verticalAlign: 'start',
    height: height,
    margin: '0'
  }} />;
};

### Intro

Group Management allows you to manage your Domo groups in bulk. You can also set a landing page for members of a group.

***

### Access the Toolkit

To access the Governance Toolkit, do the following:

1. In the navigation header, go to
   **More** > **Admin.**
2. In the
   **Governance** menu, select **Toolkit.**

   <Note>
     **Note:**
     If the
     **Toolkit**
     option does not display in the
     **Governance**
     menu, make sure your user role has the required grants. You may need to enable the Toolkit by reaching out to your Account Executive (AE).
   </Note>

### Required Grants

To access the Governance Toolkit, a user will need one of two grants enabled for their role: Create Custom Pipeline Processes or Administer Custom Pipeline Processes. Grants can be added to a custom user role. By default, the Administer Custom Pipeline Process grant is enabled for Admin users.

* **Create Custom Pipeline Processes
  —** Allows the holder to create, update, share, and delete jobs. Only allows the user to view jobs that they created or jobs that have been shared with them.
* **Administer Custom Pipeline Processes
  —** Allows the holder to create, update, share, and delete jobs. Allows the user to see all jobs within the pipeline.
* **Manage DataSet —**
  Allows the holder to view, edit, and delete any DataSets in this instance.
* **Manage All Groups —**
  Allows the holder to create, edit, and delete any groups, and add and remove people from any group.
* **Manage All Cards, Pages, Apps (App Studio/Worksheets), and Reports (Report Builder) —**
  Allows the holder to view, edit, share, and delete any card, dashboard, App Studio app, or Report Builder report in the instance. The holder can also subscribe to publications from other instances. Learn more about [publications](https://domo-support.domo.com/s/article/360045120554?language=en_US).

To learn more about custom roles and grants, see [Managing Custom Roles.](/s/article/360043438973)

### Configuration DataSet for Adding Members to a Group

<Warning>
  **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.
</Warning>

This section describes the columns in the configuration DataSet for adding members to a group.

* User

  * The users that should be included in the group.

  * Multiple users can be pipe ‘|’ separated.

  * User ID and email can be used.
* Group

  * The name or ID of the group that users should be added to.

  <Frame>
    <img alt="group management dataset.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005wpSB.jpg?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=e18a8a43782f1c21fbb8857208be0497" style={{width: 501, height: 388}} width="1404" height="1088" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005wpSB.jpg" />
  </Frame>

### Configuration DataSet for Setting a Group Landing Page

<Warning>
  **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.
</Warning>

This section describes the columns in the configuration DataSet for setting a landing page for a group.

* **priority —**
  If a user is a member of multiple groups, the priority determines which landing page they have.

  * If both a card\_id and page\_id are given, the page is set as the landing page.

  * If a user is a member of multiple groups of equal priority, the landing page is assigned alphabetically based on the group name.
* **group —**
  The name or ID of the group that the landing page is set for.
* **page\_id —**
  The ID of the page being set as the landing page.

  * In each row, the page in the `page\_id` field must be shared with all members of the group identified in the `group` field. If multiple groups have the same Group Landing page being set to the same page in the config DataSet, and all members of all groups do not have this shared properly, the job will fail for all included groups.
* **card-id —**
  The ID of the card to be set as the landing page.

<Frame>
  <img alt="set_landing_page.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNob.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=b2de2656feb0b48346b11c80fc6f8ccf" style={{width: 830, height: 198}} width="1430" height="342" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNob.png" />
</Frame>

### Create a Job

Follow these steps to create a job in Group Management:

1. In the navigation header, go to
   **More** > **Admin.**

2. In the
   **Governance** menu, select **Toolkit.**

3. In
   **Toolkit**, select **Group Management**.

4. Select
   **+ New Job**.

   The new job creation page displays.

<Frame>
  <img alt="Screen_Shot_2022-08-03_at_5.18.10_PM.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNod.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=5c9ece8660280620ca26f95ce808d8a3" style={{width: 902, height: 515}} width="2660" height="1518" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNod.png" />
</Frame>

5. Enter a
   **Job name** and optional **Job description.**

6. In the
   **Configuration** section, check one or both of the boxes for your **Job options:**

   * **Manage Groups —**
     Use this option to create membership groups as necessary and manage them.
   * **Manage Landing Pages —**
     Use this option to assign landing pages or cards to members of existing groups. This option includes assigning landing pages for directory groups inherited from SSO.

7. (Required) Select a Configuration DataSet for each selected job option.

   * The
     **Group Management Configuration DataSet** defines your groups and users in each group.
   * The
     **Landing Page Management Configuration DataSet** defines which landing pages are set.

8. (Required for group management) Choose how to handle creating new groups. Select the radio button for
   **Open** or **Closed**.

9. In
   **Reporting**, select where you would like to save run logs.

   * **New DataSet —**
     This option creates a new DataSet in your Domo instance and all runs of the job write logging to the new DataSet.
   * **Existing DataSet —**
     This option allows you to combine multiple Group Management jobs into a single logging DataSet.

   <Warning>
     **Important:**
     The DataSet must be a DataSet created by the Group Management tool. The DataSet must also already contain rows of data.
   </Warning>

10. In
    **Reporting**, enter any email addresses you would like to receive notifications from Domo each time the job runs. The notification outlines what the job did during the run and any failures that occurred.

    Sample Notification Email

<Frame>
  <img alt="Group_Management_Notification.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNof.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=cdcfdfcc6aaecc161d2701bfac931d06" style={{width: 351, height: 286}} width="1490" height="1218" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNof.png" />
</Frame>

11. After you fill out the new job creation page, select
    **Submit**.

### Run a Job

You can run a job by using the **Enabled** toggle. The toggle displays on the **Group Management** page after you create a job.

When you switch the toggle to **Active**, the job will execute every six hours and when the configuration DataSet is updated. When the toggle is **Disabled**, the job only executes when it is manually run.

<Frame>
  <img alt="enabled_toggle.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoZ.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=8d71eec7f8571a64312494bfc432f434" style={{width: 840, height: 78}} width="2272" height="212" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoZ.png" />
</Frame>

#### Example Job Run

* Groups before run:

  <Frame>
    <img alt="Group_Management_5.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoa.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=d7c590ca7b194fa7823f50c8d8fec453" style={{width: 901, height: 296}} width="5116" height="1680" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoa.png" />
  </Frame>
* Configuration DataSet:

  <Frame>
    <img alt="config_dataset.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoc.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=f0cc5c23c23fd62c9521c8e25d45f594" style={{width: 901, height: 698}} width="1404" height="1088" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoc.png" />
  </Frame>
* Groups after run:

  <Frame>
    <img alt="Group_Management_6.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoe.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=f886c304116a35d87fadc81d6fb7b575" style={{width: 902, height: 359}} width="5118" height="2038" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoe.png" />
  </Frame>
* Logging DataSet:

  <Frame>
    <img alt="Group_Management_Metrics.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/ag1wPXP26szkgB9J/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoY.png?fit=max&auto=format&n=ag1wPXP26szkgB9J&q=85&s=4ea0cbc9c8b744ac68325727aff4af4c" style={{width: 901, height: 283}} width="5110" height="1604" data-path="images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000005vNoY.png" />
  </Frame>

### Remote Instance Configuration

Remote instance configuration allows you to be in one Domo instance and configure Group Management for other instances to which you have access. To configure Group Management remotely, you need a [configuration DataSet](#config_dataset), described previously in this article. You also need a [Domo Access Token account](#configure_domo_access_token) configured with either a [Domo Access token](#generate_access_token) or with a username and password for the remote instance.

# Configure Group Management for Remote Instance

1. While creating or editing a job for Group Management, in the
   **Configuration** section, select a configuration DataSet populated with valid values for the remote instance according to Group Management guidelines given in this article. See [Configuration DataSet](#config_dataset).

2. Still in the
   **Configuration** section, choose **Remote Instance** for where to run the job.

   The **Instance Settings** display.

3. In the
   **Instance:** field, enter the domain for the remote instance you want to manage groups for.

4. From the
   **Select the account for your instance:** list, select a valid [Domo Access Token account](#configure_domo_access_token). To learn how to configure a Domo Access Token account, see the next section.

5. Fill in the details for the
   **Reporting** section.

   <Note>
     **Note:**
     The notification emails and metric logs are written to the instance the policy is running from, not to the remote instance.
   </Note>

6. Select
   **Submit** to save your changes to the job.

# Configure Domo Access Token Account

Follow these steps to configure a Domo Access Token account:

1. In the Domo navigation header, select
   **Data**.

   The **Data Center** opens.
2. In the sidebar, select
   <InlineImage src="/images/kb/ka0Vq000000GUN7-00N5w00000Ri7BU-0EM5w000006uFA5.jpg" /> **Accounts**.
3. Select
   **Add New** > **Account**.

   The **Add Account** modal displays.

   <Frame>
     <img alt="domo access token.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/y73kYVYT02nhoBL7/images/kb/ka05w00000129aT-00N5w00000Ri7BU-0EM5w000006uF9v.jpg?fit=max&auto=format&n=y73kYVYT02nhoBL7&q=85&s=83af8d79dff5c4f1336d08620f5a3aab" style={{width: 576, height: 624}} width="936" height="1014" data-path="images/kb/ka05w00000129aT-00N5w00000Ri7BU-0EM5w000006uF9v.jpg" />
   </Frame>
4. In the modal, complete one of the following options:
   * **Access Token —**
     Enter an access token in the **Remote Instance Access Token** field. To learn how to generate a token, see [Generate Access Token](#generate_access_token).
   * **Username and password —**
     Enter your credentials in the **Remote Instance Username** and **Remote Instance Password** fields.
5. Select
   **Connect**.

# Generate Access Token

Follow these steps to generate an access token:

1. In the Domo navigation header, select
   **More** > **Admin**.

   The Admin Settings display.
2. In the
   **Authentication** menu of the Admin Settings, select **Access tokens**.
3. On the
   **Access tokens** page, select **+ Generate access token**.

   <Frame>
     <img alt="generate token.jpeg" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/enfTkpqxhZnichpt/images/kb/ka05w00000128xR-00N5w00000Ri7BU-0EM5w000006uFA0.jpg?fit=max&auto=format&n=enfTkpqxhZnichpt&q=85&s=d66be05545cc2be432d7a34000bdfc0c" style={{width: 670, height: 66}} width="1456" height="144" data-path="images/kb/ka05w00000128xR-00N5w00000Ri7BU-0EM5w000006uFA0.jpg" />
   </Frame>
4. Enter a description in the
   **Access token description** field.
5. Search for and select a user for whom you are generating the access token.
6. Select an expiration interval in the
   **Expire after** list.
7. Select
   **Generate**.
8. Copy the code to use.
