ISVforce Guide

Introduction
ISVforce Quick Start
Designing and Building Your App
Overview of Packages
Components Available in Managed Packages
About API and Dynamic Apex Access in Packages
Architectural Considerations for Group and Professional Editions
Connected Apps
Creating a Connected App
Edit, Package, or Delete a Connected App
Installing a Connected App
View Connected App Details
Manage a Connected App
Edit a Connected App
Monitoring Usage for a Connected App
Uninstalling a Connected App
Environment Hub
Packaging and Testing Your App
Passing the Security Review
Publish Your Offering on the AppExchange
Manage Orders
Managing Licenses
Provide a Free Trial
Supporting Your Customers
Upgrading Your App
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Edit, Package, or Delete a Connected App

Available in: both Salesforce Classic and Lightning Experience
Connected Apps can be created in: Group, Professional, Enterprise, Performance, Unlimited, and Developer Editions

Connected Apps can be installed in: All Editions

User Permissions Needed
To read: “Customize Application”
To create, update, or delete: “Customize Application” AND either

“Modify All Data” OR “Manage Connected Apps”
To update all fields except Profiles, Permission Sets, and Service Provider SAML Attributes: “Customize Application”
To update Profiles, Permission Sets, and Service Provider SAML Attributes: “Customize Application” AND “Modify All Data”
To uninstall: “Download AppExchange Packages”

After creating a connected app, you can edit, package, or delete it.

The name must be unique for the current connected apps in your organization. You can reuse the name of a deleted connected app if the connected app was created using the Spring ’14 release or later. You cannot reuse the name of a deleted connected app if the connected app was created using an earlier release.

Note

Editing a Connected App

You can update a connected app at any time. From Setup, enter Apps in the Quick Find box, then select Apps. Select a connected app name in the list and click Edit. Save your changes by clicking Save.

After you’ve created the connected app, you can go back to the detail page to specify the allowed IP ranges.

The IP ranges work with OAuth-enabled connected apps, not SAML-enabled connected apps, and specify valid IP addresses for the connected app.

Use the following steps to set the allowed IP range.

  1. From Setup, enter Apps in the Quick Find box, then select Apps.
  2. Select a connected app name in the list.
  3. In the Trusted IP Range for OAuth Web server flow section, click New.
  4. Enter a valid IP address in the Start IP Address field and a higher IP address in the End IP Address field.

    You can enter multiple, discontinuous ranges by clicking New to enter each range.

You can allow specific users to access the connected app from outside of the Trusted IP Range, for OAuth-enabled connected apps. For example, to allow access to some users while traveling, set the connected app to Relax IP Restrictions with second factor.  When a user attempts to use the connected app from outside this range, the user is prompted to provide a second factor of authentication, such as a token code. After a successful second factor authentication, the user can use the connected app from outside the Trusted IP Range.

  1. From Setup, enter Connected Apps in the Quick Find box, then select the option for managing connected apps..
  2. Click Edit next to the connected app name to display the values for the app.
  3. In the IP Relaxation field, select Relax IP Restrictions in the drop-down list.

If the Enforce login IP ranges on every request Session Settings option is enabled, it affects the IP relaxation behavior. For more information, see Connected App IP Relaxation and Continuous IP Enforcement.

Note

After you’ve created the connected app, you can go back to the detail page and specify custom attributes. Custom attributes specify SAML metadata or specify OAuth parameters that are read at OAuth runtime.

  1. From Setup, enter Apps in the Quick Find box, then select Apps.
  2. Select a connected app name in the list.
  3. In the Custom Attributes section, click New.

    Each custom attribute must have a unique key and must use fields available from the Insert Field menu. For example, assign a key name, such as country and insert the field $Organization.Country. When using SAML, attributes are sent as SAML attribute statements. When using OAuth, attributes are available as a custom_attributes object in the user’s Identity URL.

The following custom attributes are available for Salesforce1 connected apps.

Table 1. Salesforce1 Connected App for Android Custom Attributes
Attribute Key Attribute Value Description
CALL_HISTORY
  • DISABLED
  • ADMIN_DEFINED
  • SIMPLE
  • If set to DISABLED, removes call logging from the navigation menu.
  • If set to ADMIN_DEFINED, enables native Android call logging.
  • If set to SIMPLE, enables Aura call logging.
Table 2. Salesforce1 Connected App for iOS Custom Attributes
Attribute Key Attribute Value Description
USE_ALTERNATE_USER_PROFILE
  • TRUE
  • FALSE
  • If set to TRUE, enables Aura profile home.
  • If set to FALSE, enables native iOS profile home.
SHOW_OPEN_IN
  • FALSE
  • If set to FALSE, disables users from sharing a file using a link to the file, or opening a file in a third-party app.
When defining custom attributes, wrap attribute values in quotation marks.

As you update fields for a connected app, be aware that changes to some fields immediately apply to all installed versions of the connected app, too. These are version-independent fields that bypass the packaging or installation lifecycle. Users of the connected app will see things like the description change. The following fields have this version-independent behavior.

Description

Info URL

Logo Image URL

Callback URL

Important

Packaging a Connected App

After creating a connected app or a new version of an existing app, package it to make it available to users on other Salesforce organizations. You add a connected app to a managed package in the same way as, and along with, other components such as custom objects, Visualforce pages, or Apex classes. This makes it easy to distribute a connected app to other Salesforce organizations. As a packageable component, connected apps can also take advantage of all other features of managed packages, such as listing on the AppExchange, push upgrades, post-install Apex scripts, license management, and enhanced subscriber support.

You can only package a connected app from a Developer Edition organization. Connected apps can be added to managed packages, only. Connected apps are not supported for unmanaged packages.

Note

Deleting a Connected App

To delete a connected app, click the Connected App Name in the list of apps. Click Delete on the editing page and confirm by clicking Delete again. Even though the app is removed from your list, you cannot reuse the app name.

If you delete a connected app that has been included in a package, the app remains available in the package until you update the package.

If user provisioning has been configured for a connected app, you can’t delete the connected app or uninstall a package that contains it until an administrator removes the user provisioning configuration details. Be aware that deselecting the Enable User Provisioning checkbox on the connected app detail page doesn’t remove the configuration details from the organization. To remove the configuration details, see the instructions for Salesforce administrators in this known issue.

Note