Developer Console
Sign In
Sign In
Developer Console

Register for Login with Amazon

 LWA for iOS

STEP 1:
Install the LWA SDK for iOS
→
STEP 2:
Run the Sample App
→
STEP 3:
Register with LWA
→
STEP 4:
Create a LWA Project
→
STEP 5:
Add a LWA Button to Your App
→
STEP 6:
Use the LWA SDK for iOS APIs
→
STEP 7:
Integrate with Your Account System

Before you can use Login with Amazon in your iOS app, you must register the application with Login with Amazon. Your Login with Amazon application registration contains basic information about your business, and information about each website or mobile app you create that supports Login with Amazon.

This business information is displayed to users each time they use Login with Amazon on your websites and mobile app. Users will see the name of your application, your logo, and a link to your privacy policy. These steps demonstrate how to register your iOS app for use with Login with Amazon.

Create a New Security Profile

Skip this section if you have already created a security profile in the Amazon Developer Console.

  1. Visit https://developer.amazon.com/loginwithamazon/console/site/lwa/overview.html. You will be asked to login to the Developer Console, which handles application registration for Login with Amazon. If this is your first time using the Developer Console, you will be asked to set up an account.

  2. Click Create a New Security Profile. This will take you to the Security Profile Management page.

    1. Enter a Name and a Description for your security profile. A security profile associates user data and security credentials with one or more related apps. The Name is the name displayed on the consent screen when users agree to share information with your application. This name applies to Android, iOS, and website versions of your application.

    2. You must enter a Consent Privacy Notice URL for your application. The Privacy Notice URL is the location of your company or application's privacy policy (for example, http://www.example.com/privacy.html). This link is displayed to users on the consent screen. It applies to Android, iOS, and website versions of your application.

    3. If you want to add a Consent Logo Image for your application, click Upload Image. This logo is displayed on the sign-in and consent screen to represent your business or website. It applies to Android, iOS, and website versions of your application. The logo will be shrunk to 50 pixels in height if it is taller than 50 pixels; there is no limitation on the width of the logo.

  3. Click Save. Your security profile should look similar to this:

    Created Security Profile

Enable your Existing Security Profile for Login with Amazon

Skip this section if you used the instructions above to create a new security profile. Security profiles created using the instructions above are already enabled for Login with Amazon.

  1. Visit https://developer.amazon.com/loginwithamazon/console/site/lwa/overview.html. You will be asked to login to the Developer Console.

  2. Click Select a security profile, then choose your security profile from the drop-down menu.

    Enabling LWA for your Security Profile

  3. Click the Confirm button that appears to the right.

  4. A form appears, where you must enter consent screen information.

    Adding consent screen information to your Security Profile

  5. You must enter a Consent Privacy Notice URL for your application. The Privacy Notice URL is the location of your company or application's privacy policy (for example, http://www.example.com/privacy.html). This link is displayed to users on the consent screen. It applies to Android, iOS, and website versions of your application.

  6. If you want to add a Consent Logo Image for your application, click Upload Image. This logo is displayed on the sign-in and consent screen to represent your business or website. It applies to Android, iOS, and website versions of your application. The logo will be shrunk to 50 pixels in height if it is taller than 50 pixels; there is no limitation on the width of the logo.

  7. Click Save. The screen will refresh, and show a message underneath the Confirm button that states: "Login with Amazon successfully enabled for security profile".

Add your iOS App to your Security Profile

After creating a security profile on the Developer Console, you can add settings for specific websites and mobile apps that will use Login with Amazon with that profile. To register a new iOS app, you have to specify the package name and signature for the app project. Login with Amazon will use these values to generate an API key . The API key will grant your app access to the Login with Amazon authorization service . Follow these steps to add an iOS app to your profile:

  1. Visit https://developer.amazon.com/loginwithamazon/console/site/lwa/overview.html.
  2. Go to the security profile that you want to use for your app.
    1. Locate the security profile you want to modify from the table.
    2. Hover over the actions button  button shown in the Manage column.
    3. Select the iOS Settings menu item.
      Note: If your desired security profile is not shown in the table, it is not yet enabled for Login with Amazon. In this case, use the drop-down menu above the table to Select a Security Profile, then click Confirm. You'll be required to enter a Consent Privacy Notice URL and optionally select a Consent Logo Image, both of which will be displayed on the sign-in and consent screens. If you don't have an existing security profile for your app, see Create a New Security Profile.
  3. Enter the API Key Name that your app will use to authenticate with Login with Amazon. This does not have to be the official name of your app. It simply identifies this particular iOS app among the apps and websites registered to your security profile.
  4. Enter your Bundle ID. This must match the bundle identifier of your iOS project. To determine your bundle identifier, open the project in Xcode. Open the properties list for the project (<project>-Info.plist) in the Project Navigator. The Bundle identifier is one of the properties in the list.
  5. Click Generate New Key.

If different versions of your app have different bundle IDs, such as for one or more testing versions and a production version, each version requires its own API Key. From the iOS Settings of your app, click the Add an API Key button to create additional keys for your app (one per version).

iOS Bundle ID and API Keys

The Bundle identifier is unique to every iOS app. Login with Amazon uses the Bundle ID to construct your API Key. The API Key enables the Login with Amazon authorization service to recognize your app.

Determining a Bundle Identifier for an iOS App

  1. Open your app project in Xcode.
  2. Open the Information Property List for the project (<project>-Info.plist) in the Project Navigator.
  3. Find Bundle identifier in the list of properties.

Retrieving an iOS API Key

After you have associated an iOS app with a security profile, you can retrieve the API key from the iOS Settings tab in your security profile. You will need to place that API key into your project. Until you do, the app will not be authorized to communicate with the Login with Amazon authorization service.

  1. Visit https://developer.amazon.com/loginwithamazon/console/site/lwa/overview.html.
  2. Go to the security profile that you want to use for your app:
    • Locate the security profile you want to modify from the table.
    • Hover over the actions button button shown in the Manage column.
    • Select the iOS Settings menu item.

  3. Find the API Key Name for the key on the list, then click Show in the associated Key column. Copy the API Key that appears in the popup window.
    Note: The API Key is based, in part, on the time it is generated. Thus, subsequent API Keys you generate may differ from the original. You can use any of these API Keys in your app as they are all valid.

    You can also delete or edit any of your keys by hovering over the actions button icon and selecting Edit or Delete. Any mistakenly deleted keys can be restored by clicking Show Deleted API Keys, then clicking Restore next to the name of the key you’d like to recover.

  4. See Add Your API Key to Your App Property List for instructions on adding the API key to your app.

Delete your Security Profile

If needed, you can delete any security profile not associated with an app distributed through the Amazon Appstore. Navigate to the Security Profile Management page, select a profile, and then click Delete Security Profile. A confirmation form appears. Type the word delete into the text field then click Delete to confirm the action.

If a security profile is mistakenly deleted, it’s fully recoverable from the Security Profile Management page. Click the Show Deleted Security Profiles button, click on the name of the profile you’d like to restore, then click Restore Security Profile. A confirmation form appears. Click the Restore button to recover the security profile, including its Web, Android/Kindle, and iOS settings.

Last updated: Dec 20, 2023