Service Accounts

Overview

A Service Account is required for each of the three onboarding environments: API Integration (AIE), Data Qualification (DQE), and Production. You must create a separate Service Account for each environment.

Create a Service Account

1. Navigate to API Settings

1. Sign in to the Apple Business portal with an administrator role.
2. If you are the administrator for more than one organization, select the target organization.
3. If necessary, add a team member to the Service Account. See Apple Business User Guide > Add, edit, and delete team members.
4. Select your organization, then select API.

2. Create the Service Account

1. Select the more () button for the appropriate onboarding phase.
2. Select Add Service Account.
3. Configure the service account:

• Name: Use a name that is appropriate for the environment (For example, "AIE Testing", "DQE Validation", "Production").
• Email: Provide the service account's email address.
• Permissions: Select Read + Write.

4. Select Continue.

3. Save Credentials

1. Copy the Client ID and Client Secret Key to a secure location.

note

The Client ID and Client Secret are required for environment access and are displayed only once. If you close this window without copying the Client Secret Key, you must generate a new one.

2. Select Done.

Remove a Service Account

1. Navigate to the Service Account

1. Sign in to Apple Business with an administrator role.
2. If you manage multiple organizations, select the target organization.
3. Select your organization > API > and then the appropriate onboarding phase ().

2. Remove the Account

1. Select the Service Account you wish to remove.
2. Select Remove. The Service Account and all its connections to Apple Business will be removed.