iOS Auto Provision with App Store Connect API (Deprecated)

⚠️   This Step has been deprecated in favour of the new automatic code signing options on Bitrise. Option A) The latest versions of the [Xcode Archive & Export for iOS](https://github.com/bitrise-steplib/steps-xcode-archive), [Xcode Build for testing for iOS](https://github.com/bitrise-steplib/steps-xcode-build-for-test), and the [Export iOS and tvOS Xcode archive](https://github.com/bitrise-steplib/steps-export-xcarchive) Steps have built-in automatic code signing. We recommend removing this Step from your Workflow and using the automatic code signing feature in the Steps mentioned above. Option B) If you are not using any of the mentioned Xcode steps, then you can replace this iOS Auto Provision Step with the [Manage iOS Code signing](https://www.bitrise.io/integrations/steps/manage-ios-code-signing) Step. You can [read more](https://blog.bitrise.io/post/simplifying-automatic-code-signing-on-bitrise) about these changes in our blog post.

This Step has been deprecated in favour of the new automatic code signing options on Bitrise.

You can read more about these changes in our blog post: https://blog.bitrise.io/post/simplifying-automatic-code-signing-on-bitrise.

Option A)

The latest versions of the Xcode Archive & Export for iOS, Xcode Build for testing for iOS, and the Export iOS and tvOS Xcode archive Steps have built-in automatic code signing. We recommend removing this Step from your Workflow and using the automatic code signing feature in the Steps mentioned above.

Option B)

If you are not using any of the mentioned Xcode Steps, then you can replace this iOS Auto Provision Step with the Manage iOS Code signing Step.

Description

The Step uses the official App Store Connect API. The Step can obtain the API connection information in 2 ways: It can use either the Bitrise Apple Developer connection selected under the Team tab for the application, or you can provide the information to the Step using Step's input variables. The Steps performs the following:

• It generates, updates and downloads the provisioning profiles needed for your iOS project.
• It verifies if your project is registered with the App Store Connect. If it was not, the Step registers your project.
• It registers the iOS devices connected to your Bitrise account with the App Store Connect.
• It modifies the iOS project to use manual code signing if the project uses automatically managed signing.

Configuring the Step

Before you start configuring the Step, make sure you've completed the following requirements:

1. You've generated an API key and obtained an Issuer ID, Key ID and a Private Key.
2. You've defined your Apple Developer Account to Bitrise.
3. You've assigned an Apple Developer Account to your app.

Once these are done, most of the required Step input fields are already populated for you.

To configure the Step:

1. Add the iOS Auto Provision with App Store Connect API after any dependency installer Step in your Workflow, such as Run CocoaPods install or Carthage.
2. Click the Step to edit its input fields. You can see that the Build API token, Build URL, and the Xcode Project (or Workspace) path inputs are automatically filled out for you.
   • Build API token: Every running build has a temporary API token on a Bitrise virtual machine. This token is only available while the build is running. The Step downloads the connected API key with the help of this API token and Bitrise saves it in a JSON file.
   • Build URL: URL of the current build or local path URL to your apple_developer_portal_data.json.
   • Xcode Project path: The path where the .xcodeproj / .xcworkspace is located.
3. Distribution type input's value has to match with the value of the Select method for export input in the Xcode Archive & Export for iOS Step.
4. With the Scheme name input you can restrict which targets to process.

Troubleshooting

Make sure you do not have the Certificate and Profile Installer Step in your Workflow. Make sure that you do NOT modify your Xcode project between the iOS Auto Provision with App Store Connect API and the Xcode Archive & Export for iOS Steps. For example, do not change the bundle ID after the iOS Auto Provision with App Store Connect API Step.

Useful links

• Managing iOS code signing files - automatic provisioning
• About iOS Auto Provision with Apple ID

Related Steps

• iOS Auto Provision with Apple ID
• Xcode Archive & Export