Improve API documentation by listing required permissions for each endpoint
As global platform administrators, we are responsible for creating Developer Console credentials and distributing them to each sandbox administrator. These credentials are intentionally configured with the minimum permissions required to perform the requested action.
Today, when a sandbox administrator requests access to a capability such as Data Ingestion, we can find the API documentation that explains the available endpoints and how to use them. However, we cannot find clear information in either the API documentation or Experience League about which specific permissions are required for each operation.
For example, the documentation may describe a method such as POST – Create a new batch, including the request format and usage, but it does not indicate which AEP permissions must be assigned to the Developer Console credential in order to execute that operation successfully.
Requested improvement:
Please add, within each API method or endpoint documentation page, a small highlighted section that clearly states the required permissions/roles/scopes needed to use that operation.
Example:
For POST – Create a new batch, include a note or box indicating the exact AEP permissions that must be granted to the credential in Developer Console.
Why this is important:
- Helps administrators assign the correct minimum permissions from the start
- Reduces trial and error when configuring credentials
- Speeds up onboarding for sandbox administrator and teams consuming the APIs
- Improves security by reinforcing least-privilege access
- Reduces support requests caused by missing or unclear permission requirements
