--- schema_version: "1" id: 55a202f3f36ee5ef572d8ff516d20e1e10746f230025e1236a43d4d88e372398 title: Migrate Client Applications collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/api-manager/latest/migrate-client-apps.md canonical_url: https://docs.mulesoft.com/api-manager/latest/migrate-client-apps source_site: docs.mulesoft.com content_type: documentation content_hash: 939cde85a4d6edcc7b35ca2b56bf6d6d2855d708c4a79e9fc4230887996d5a96 description: MuleSoft Documentation Site release: 2.x latest: true --- --- product: API Manager version: 2.x is-latest-version: true keywords: migrate client applications, migrate applications, migrate --- # Migrate Client Applications > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You might have application client credentials residing outside of Anypoint Platform if you were previously using a different API management solution. You must first migrate those client applications to Anypoint Platform, with their client ID and client secret credentials, before you can start using the credentials in Anypoint Platform. Your client applications can consume APIs whose organization is associated to an Anypoint Platform client provider or an external client provider. The instructions for these two scenarios differ: - [Migrate client applications for APIs with Anypoint Platform client providers](#migrate_with_internal) - [Migrate client applications for APIs with external client providers](#migrate_with_external) ## Prerequisites Before migrating the client application, ensure that you: - Obtain the required token and credentials: - Client ID and client secret for the client application to migrate - Anypoint Platform [token](https://dev-portal.mulesoft.com/apis/access-management.html) - Review the [scope and limitations](#considerations) ## Scope and Limitations Before you migrate your client applications to Anypoint Platform, review the following scope and limitations: - Do not attempt to update the client ID and client secret of your application. This feature is not supported. - Because client IDs are unique in Anypoint Platform, do not reuse the same client ID in two different accounts. To avoid the duplication, specify unique client IDs for your accounts. - Do not use the same user to create more than 500 applications. - Do not create applications with duplicate names. - Do not attempt to refresh the client ID unless you first delete and then re-register the client application. - If the client credentials you provide match the credentials of an existing organization ID on the client provider, the application is associated with that client. Conversely, if the client credentials that you provide do not match, the client application is created with no association to existing clients. ## Migrate Client Applications for APIs with Anypoint Platform Client Providers To migrate your client application: 1. Open a text editor and paste the following commands: ```text curl --location --request POST 'https://anypoint.mulesoft.com/exchange/api/v1/organizations/:orgId/applications' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data-raw '{ "clientId": , "clientSecret": , "grantTypes": [], "name": , "redirectUri": [] }' ``` 2. Replace the `orgId` parameter with the ID of your root organization and the content of the body with the appropriate application [properties](#properties). 3. Run this command at the command prompt. ## Migrate Client Applications for APIs with External Client Providers When creating an application for an organization with registered external client providers, you can directly associate the application with the API that you want to consume, using that API instance ID (available from the API Manager UI). If you use a PingFederate external client provider or the Anypoint Platform client provider, you can include the client ID and client secret when referencing an API. Otherwise, for providers like Okta or Keycloak, which are registered using OpenID Dynamic Client registration, you cannot define client ID and client secret credentials. To migrate your client application: 1. Open a text editor and paste the following commands: ```text curl --location --request POST 'https://anypoint.mulesoft.com/exchange/api/v1/organizations/:orgId/applications?apiInstanceId=:myApiInstanceId' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data-raw '{ "clientId": , "clientSecret": , "grantTypes": [ ], "name": , "redirectUri": [ "https://anypoint.mulesoft.com/apiplatform/:orgId/authentication/oauth2.html", "https://anypoint.mulesoft.com/apiplatform/:orgId/admin/authentication/oauth2.html", ] }' ``` 2. In the command snippet, replace the `orgId` parameter with your organization ID, `apiInstanceId` with the API instance ID, and the content of the body with the appropriate application [properties](#properties). > [!IMPORTANT] The API instance ID must be configured to use the external client provider before > running this command. If you need to change the client provider on an existing API instance, > delete all existing contracts for that instance first. 3. Run this command at the command prompt. ## Migrate Command Properties Reference In the properties of the migrate command, provide values based on the following recommendations: - `clientId`: - `clientSecret`: - (optional)`description`: This property is displayed on the application page. - `name`: This property is displayed when selecting an application before requesting access. - `redirectUri`: - (optional) `url`: This property is displayed on the application page. - `grantTypes`: - `Resource Owner Grant`: "password" - `Implicit Grant`: "implicit" - `Client Credentials Grant` "client\_credentials" - `Authorization Code`: "authorization\_code" - `Refresh Token`: "refresh\_token" (Authorization Code must be present to use this grant type.) For more information about which grant types your external client provider supports, see your client provider documentation.