Skip to main content

Creating and managing service accounts

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

Preparing to create a service account

To prepare for the service account:

  1. Login to the application as an administrator of the organization.

  2. From the user menu available in the top toolbar, navigate to the Settings page.

  3. Go to the Advanced section and note down the Enterprise Admin API token. We will use this API token to create the service account.

    get_api_token.png

  4. Next, note down the ID of the organization for which you are creating the service account.

    service_account_note_down_ID.png

Setting up the service account

To setup a service account:

  1. Access the create a new service account API. Set the following parameters.

    create_service_account.png

  2. In the Auth section set the Token value as Bearer <API_TOKEN_Copied_from UI>. For example, the value will look like: Bearer OiJIUzUxMiJ9.eyJzdWIiOiJ.

    Important

    You must add Bearer along with API token.

  3. In the Parameters section set the Owner as the ID of the organization for which you are creating the service account. This should be the organization in which you are planning to run the collectors. If you are using the Catalog Toolkit, it must be the catalog-sources organization. For example, the value will look like: catalog-sources

  4. In the Body section, set the following properties:

    1. desiredUsername: Set the username for the account. This is the name with which the account gets created.

    2. expiryDate: Set an expiration date. The generated token expires on this date and will need to be regenerated on that date.

    3. displayName: Set the display name. The display name can have maximum 128 characters.

  5. Click the Send API request button.

  6. If the API request is sent successfully, the Response section refreshes and shows a 200 OK response and the following information:

    1. Token: This is the token generated for the service account you created. This token is used while running the collectors.

      Important

      You must use discretion while sharing and using this token. You must save this token in a safe place as it cannot be retrieved. If you lose the token, you will have to generate a new one.

    2. serviceAccountUsername: This is the name with which the account gets created in the organization. The system automatically prefixes the name with sa-<organizationID>. For example, if you set the desiredUsername as new-service-account for the 8bank organization, the serviceAccountUsername will get created as sa-8bank-new-service-account.

Managing the service account

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

To manage 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.

    service_account_in_org.png
In this section: