Skip to main content

Creating and managing service accounts

Important

This topic only applies to on-premise collector runs.

This section walks you through the process of creating a service account for running the metadata collectors.

Creating a service account

To create a service account:

  1. On the Organization profile page, go to the Settings tab.

  2. From the Service accounts section, click the Add service account button.

    create_service_account_UI_01.png
  3. In the Create a new service account window, set the following and click Create.

    • Service account name: This is the name with which the account gets created.

    • Token expiration: Set an expiration timef rame. Options available are 1 year, 1 month, 1 week, and Never. The generated token expires on the set time and will need to be regenerated again.

    create_service_account_UI.png
  4. Once the service account is created, you are prompted to note down the Service account token.

    Important

    You must note down this token and the expiration date before closing the window as this token cannot be retrieved after the window is closed.

    create_service_account_UI_02.png

Assigning Dataset Permissions to Service Account

This is the account you will use to upload the collector output to the dataset.

To assign permissions to the service account:

  1. Go to the organization for which you created the service account.

  2. In the Members tab, you will see the service account. Give this account permissions to the datasets in which the collector output will be saved. At a minimum the account must have Edit access to the dataset.

    create_service_account_UI_03.png

Refreshing access token

Warning

Caution should be used while refreshing the service accounts. Refreshing the token invalidates any usages of the existing token attached to this service account.

To refresh an access token:

  1. On the Organization profile page, go to the Settings tab.

  2. From the Service accounts section, locate the account you want to refresh.

  3. Open the Three dot menu and click the Refresh button.

    create_service_account_delete_UI.png

Deleting service accounts

Warning

Caution should be used while deleting service accounts. Deleting this service account will cause collectors or scripts using it to lose access.

To delete a service account:

  1. On the Organization profile page, go to the Settings tab.

  2. From the Service accounts section, locate the account you want to delete.

  3. Open the Three dot menu and click the Delete button.