Machine Accounts

What is a machine account?

A machine account is a special type of user for connecting your automations and integrations to the platform through the API. It has no password and can't sign in through the browser. Instead, an admin creates API keys for the machine user and your scripts and tools use those keys to authenticate.

Admins, or anyone with permission to manage users, can create and manage machine accounts.

Why use a machine account?

  • More secure. A machine account isn't tied to any one person's credentials, so you don't have to share or embed a personal API key in your integrations.

  • More reliable. Integrations keep running when someone leaves your organization or changes roles because they don't depend on that person's account.

Use a machine account whenever an automation or integration needs API access that should outlast any one person's role.

Create a machine account

You must have the “Can manage users” right to create a machine account.

  1. Navigate to Admin Panel > Users > Machine Accounts

  2. Click Add new account.

  3. Enter a name and description that identify what the machine account will be used for.

  4. Select a role for the machine account. Machine accounts cannot be assigned admin roles or any role that grants permission to manage other users.

  5. Click Create account.

After creation you can update the name and description for a machine account by selecting the Manage option from the actions menu in the Machine Accounts table. Click the pencil icon next to the metadata you would like to change. To update a machine account's role, simply select a new role from the role dropdown in the machine accounts table.

Create an API key for a machine account

  1. Open the machine account by clicking its name, or select Manage from the actions menu in the machine account table.

  2. Click Create new API key.

  3. The API key and secret appear in a confirmation modal. Copy and store the secret now, because for security reasons it can't be viewed again.

createapikey.jpg

A machine account can have multiple API keys. As a security best practice, rotate keys periodically by creating a new key, switching your integration to it, and then deleting the old one. Deleting an API key takes effect immediately and any integration still using it will stop working. To delete an API key select the trashcan icon next to the key in the API key table on the machine account's management page. 

deleteapikey.jpg

If you are looking for information about managing API keys for your personal account, check out this article.

Grant a machine account access to data

Machine accounts use the same access management tools as other users:       

  • Roles: Assign a role that follows the principle of least privilege. On an EDP (Enterprise Data Platform), you can also create a custom role tailored to the machine account's use case.

  • Asset-level access: Use the Manage Viewers and Manage Collaborators modals to grant access to individual assets. Machine accounts can be given view or edit permissions on an asset-by-asset basis.

  • Restrictions: Machine accounts cannot be assigned the Admin role or any role that includes the “Can manage users” right. This ensures a compromised machine account can't be used to grant unauthorized users access to site data.

  • Auditing: Machine account activity is recorded in the Activity Log.

Remove a machine account

You can either disable or delete a machine account.

Disable when you may need the account again. Disabling a machine account:

  • Disables its API keys.

  • Stops it from appearing in user search.

  • Leaves ownership of its assets and its asset-level permissions unchanged.

  • Lets you re-enable it later.

To disable, select Disable from the actions menu in the machine accounts table.

 

Delete when you are sure the account is no longer needed. Deleting a machine account:

  • Permanently removes the account and its API keys.

  • Automatically transfers its assets to a stand-in deleted user account.

  • Removes its asset-level permissions.

To delete, select Delete from the actions menu in the machine accounts table, or click Delete account on the machine account's management page.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.