Newer Version Available

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

Edit, Package, or Delete a Connected App

After creating a connected app, you can edit, package, or delete it at any time. For example, you can change IP ranges and add custom attributes, and package it to share with other users on your org. 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.
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”

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

Note

Edit a Connected App

You can update a connected app at any time.

  1. From Setup, enter Connected Apps in the Quick Find box, then select Manage Connected Apps.
  2. Select a connected app name in the list, and click Edit.
  3. Make the desired changes to the connected app, for example, specify allowed IP ranges, enable temporary access outside IP ranges, or add custom attributes.
  4. Save your changes by clicking Save.

After you’ve created the connected app, you can return 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 Connected Apps in the Quick Find box, then select Manage Connected 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. For the start IP address, enter a valid IP address. Enter a higher IP address for the end IP address.

    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 Manage 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 Manage Connected 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.

For your convenience, you can update some fields in a connected app and the changes apply immediately to all installed versions of the app. For example, connected app descriptions are immediately updated in each version of the connected app. The following version-independent fields bypass the packaging or installation lifecycle.

Description

Info URL

Logo Image URL

Callback URL

Important

Package 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 orgs. As a packageable component, connected apps can take advantage of all other features of managed packages. Advantages include 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 org. Also you can add connected apps only to managed packages. You can’t add them to unmanaged packages.

Note

Delete a Connected App

  1. From Setup, enter Connected Apps in the Quick Find box, then select Manage Connected Apps.
  2. Click Edit next to the name of the app you want to modify.
  3. Click Delete, and click Delete again to confirm.

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 a Salesforce admin removes the user-provisioning configuration details. Deselecting the Enable User Provisioning checkbox on the connected app detail page doesn’t remove the configuration details from the org. To remove the configuration details, see the instructions for Salesforce admins in this known issue.

Note