Skip to content

Commit

Permalink
Update documentation for Apple account management
Browse files Browse the repository at this point in the history
Visual Studio's UI for adding accounts has been unified such that it is
no longer necessary to select an option from a context-menu that pops up
after clicking the Add button.

The API Key dialog has also been updated and looks slightly different.

Documentation about how to enroll in Enterprise vs AppStoreConnect programs
as well documentation for how to generate API Keys for each of these types
of accounts has also been updated.

Fixes https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1626250
  • Loading branch information
jstedfast committed Jan 13, 2025
1 parent 7b3c6ed commit 5a17f05
Showing 4 changed files with 37 additions and 27 deletions.
64 changes: 37 additions & 27 deletions docs/ios/apple-account-management.md
Original file line number Diff line number Diff line change
@@ -6,53 +6,63 @@ ms.date: 11/08/2024

# Apple account management

When developing a .NET Multi-platform App UI (.NET MAUI) iOS app it's essential to test it by deploying it to a device, prior to uploading it to the App Store for distribution. Both of these tasks require you to have an [Apple ID](https://appleid.apple.com/account), and have enrolled your Apple ID in the [Apple Developer Program](https://developer.apple.com/programs).
When developing a .NET Multi-platform App UI (.NET MAUI) iOS app it's essential to test it by deploying it to a device, prior to uploading it to the App Store for distribution. Both of these tasks require you or someone else in your organization to enroll in one of Apple's Developer Programs:

The Apple account management interface in Visual Studio enables you to add your Apple ID, and provides the ability to view information about development teams associated with the Apple ID, view signing certificates and provisioning profiles, create new signing certificates, and download existing provisioning profiles.
1. Enrolling in Apple's [AppStoreConnect Program](https://developer.apple.com/programs/enroll) allows you to publish your iOS applications to Apple's public AppStore.
2. Enrolling in Apple's [Enterprise Program](https://developer.apple.com/programs/enterprise/) allows you to publish your iOS applications to a private "AppStore" that is fully controlled by your organization.

> [!IMPORTANT]
> Adding an Apple account that uses federated credentials isn't possible in Visual Studio.
The Apple account management interface in Visual Studio enables you to view signing certificates and provisioning profiles, create new signing certificates, and download existing provisioning profiles.

## Add an Apple Developer Account

Before you begin, ensure that you've accepted any user license agreements in your [Apple Developer Account](https://developer.apple.com/account/) and [App Store Connect](https://appstoreconnect.apple.com/).
## Accepting Apple's licensing agreement

If you have an individual Apple Developer account, as opposed to an enterprise account, you'll also need to create an App Store Connect API key. For information about creating an App Store Connect API key, see [Creating API Keys for App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api) on developer.apple.com.

To add your Apple account to Visual Studio:
Every year, Apple requires you to review and agree to their licensing agreement. To do that, sign-in to your [Apple Developer Account](https://developer.apple.com/account/) and agree to any licensing agreement that is presented to you.

1. In Visual Studio, go to **Tools > Options > Xamarin > Apple Accounts**, click on the **Add** button and select **Individual Account...** or **Enterprise Account...**:
## Generating an API Key

:::image type="content" source="media/apple-account-management/vs/add-account.png" alt-text="Add an Apple Developer Account to Visual Studio.":::
Before you can add an Apple Developer Account to Visual Studio, you will need to generate an API Key.

1. To add an enterprise account, in the **Enterprise Account...** dialog, enter your Enterprise Program API key data and click the **Add** button:
### Generating an AppStoreConnect API Key

:::image type="content" source="media/apple-account-management/vs/enterprise-account.png" alt-text="Add an Enterprise Apple Developer Account to Visual Studio.":::
If you have enrolled in Apple's **AppStoreConnect Program**, you will need to:

The **Name**, **Issuer ID**, and **Key ID** data can be found in [Apple Developer Accounts](https://developer.apple.com/account) by selecting **Users and Access** and then the **Integrations** tab. The **Private key** can also be downloaded from this location:
1. Sign-in to your [Apple Developer Account](https://appstoreconnect.apple.com)
2. Select **Users and Access**
3. Select the **Integrations** tab
4. Select the **Team Keys** tab
5. Click the **+** button

:::image type="content" source="media/apple-account-management/enterprise-details.png" alt-text="Screenshot of Apple Enterprise Program API details.":::
> [!NOTE]
> Visual Studio currently only supports **Team Keys** and does not support **Individual Keys**.
>
> Only **Admin** keys will be able to register new Bundle IDs and generate new provisioning profiles. **Developer** keys will not be able to perform these tasks.
>
> For more information about Apple's AppStoreConnect API, visit Apple's [AppStoreConnect API documentation](https://developer.apple.com/documentation/appstoreconnectapi).
Provided that your account details are valid, your Apple Developer Account will be added to Visual Studio.
### Generating an Enterprise API Key

> [!NOTE]
> Only "Admin" keys will be able to register new Bundle IDs and generate new provisioning profiles. "Developer" keys will not be able to perform these tasks.
If you have enrolled in Apple's **Enterprise Program**, you will need to:

1. To add an individual account, in the **Individual Account...** dialog, enter your App Store Connect API key data and click the **Add** button:
1. Sign-in to your [Apple Developer Account](https://developer.apple.com/account)
2. Select **Users and Access** located under the **Services** section
3. Select the **Integrations** tab
4. Click the **+** button

:::image type="content" source="media/apple-account-management/vs/individual-account.png" alt-text="Add an Individual Apple Developer Account to Visual Studio.":::
> [!NOTE]
> Only **Admin** keys will be able to register new Bundle IDs and generate new provisioning profiles. **Developer** keys will not be able to perform these tasks.
>
> For more information about how to generate an Enterprise API Key, visit Apple's [Enterprise Program API documentation](https://developer.apple.com/documentation/enterpriseprogramapi).
The **Name**, **Issuer ID**, and **Key ID** data can be found in [App Store Connect](https://appstoreconnect.apple.com/) by selecting **Users and Access** and then the **Keys** tab. The **Private key** can also be downloaded from this location:
## Add an Apple Developer Account

:::image type="content" source="media/apple-account-management/app-store-connect-details.png" lightbox="media/apple-account-management/app-store-connect-details-large.png" alt-text="Screenshot of Apple App Store Connect API details.":::
To add your Apple account to Visual Studio:

Provided that your account details are valid, your Apple Developer Account will be added to Visual Studio.
1. In Visual Studio, go to **Tools > Options > Xamarin > Apple Accounts** and click on the **Add** button:

Note: Only "Admin" keys will be able to register new Bundle IDs and generate new provisioning profiles. "Developer" keys will not be able to perform these tasks.
:::image type="content" source="media/apple-account-management/vs/add-account.png" alt-text="Add an Apple Developer Account to Visual Studio.":::

1. Once your account has been added successfully, you'll see your Apple ID and any teams that your Apple ID is part of:
1. Provide a descriptive **Name** for your API Key and copy the **Issuer ID** and **Key ID** values from Apple's website into the appropriate text boxes. If you haven't already done so, download the **Private Key** from Apple's website to a safe location and then use the **Browse...** button to select the location of the downloaded private key file.

:::image type="content" source="media/apple-account-management/vs/account.png" alt-text="Apple Developer Account added to Visual Studio.":::
:::image type="content" source="media/apple-account-management/vs/api-key-dialog.png" alt-text="Enter your API Key information.":::

## View signing certificates and provisioning profiles

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.

0 comments on commit 5a17f05

Please sign in to comment.