Edit or delete an API user

Learn how to edit, enable, disable or delete an API user.

Overview

You can make the following changes to API users in your account:

• the description
• the password
• the status (enabled or disabled)

You can also delete the API user entirely.

Before you start

• You’ll need to be an account owner or user with the Can manage account permission enabled to view the API user system area. You can find out more about amending user permissions in the Restrict and grant user access permissions article.

Edit an API user

1. Go to Settings > Access > API users.
2. Select the Edit icon to the right of the user you want to edit.
3. On the Manage users page, you can edit the description of the API user, as well as change the password.
   

   The Description field is most commonly used to help you identify the purpose of an API user, so you might enter something like ‘Magento Production’ or ‘Dynamics CRM’.

4. Once you have made your changes, select SAVE.

Enable or disable an API user

To change the status of an API user between enabled or disabled:

1. Go to Settings > Access > API users.
2. Select the Edit icon to the right of the user you want to edit.
3. On the Manage users page you will see a set of radio buttons labelled Status. Use these to enable or disable the user.
4. Once you have made your changes, select SAVE.

Delete an API user from your account

To delete an API user:

1. Go to Settings > Access > API users.
2. Select the checkbox next to the API user you want to delete, then select DELETE.
3. A window opens asking you to confirm the deletion, and warning that any functionality which makes use of the credentials being deleted will no longer work. To confirm, select DELETE.

See also

• Create an API user
• Troubleshoot API authentication problems