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
Things you need to know:
You must be an account owner or a user with the Can manage account permission enabled to view the API user system area. Learn more in Restrict and grant user access permissions.
⚠️ Protect your API credentials
API credentials must be treated as sensitive data, and never be distributed to your customers, or anyone else who does not have legitimate cause to require them. For example, do not embed them on a website, or in a mobile application. If you do, someone malicious could use those credentials to access, edit, or delete your customer data, or send spam or other harmful content which appears to come from your organisation.
Data breaches as a result of such an action could incur large financial penalties. We have some guidance around data legislation for different parts of the world in our Help Centre here, but you must also seek your own legal counsel to ensure you have adequate data protection processes in place.
Edit an API user
Expand the User menu and select Settings.
Go to Access > API users.
Select the Edit icon to the right of the user you want to edit. The Description field is most commonly used to help you identify the purpose of an API user, so you might enter something like Adobe Commerce Production or Dynamics CRM.
On the Manage users page, you can edit the description of the API user, as well as change the password or rate limiting scheme.
Once you have made your changes, select SAVE.
Enable or disable an API user
Expand the User menu and select Settings.
Go to Access > API users.
Select the Edit icon to the right of the user you want to edit.
On the Manage users page you see a set of radio buttons labelled Status. Use these to enable or disable the user.
Once you have made your changes, select SAVE.
Delete an API user from your account
Expand the User menu and select Settings.
Go to Access > API users.
Select the checkbox next to the API user you want to delete, then select DELETE.
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.
