{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following content is sample documentation for end users of your Developer portal. Organization owners can reuse this content for your own Developer portal."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before users can use the Developer portal for managing apps and API keys, organization owners need to set up the Apigee integration and configure access control for the Developer portal. See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs-legacy/developer-portal/guides/apigee-integration-portal/overview"},"children":["Overview"]}," for more information."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"manage-apps-and-api-keys-using-the-developer-portal","__idx":0},"children":["Manage apps and API keys using the Developer portal"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the Developer portal, users can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read documentation published on the Developer portal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a new app to generate an API key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage API keys"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage apps, and"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the Try it out console to test the APIs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"create-a-new-app-to-generate-an-api-key","__idx":1},"children":["Create a new app to generate an API key"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the Developer portal, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sign in"]}," (top right of the screen)."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/dp-signin-f7f895a7b61a4fb1.png","alt":"Developer portal sign in","title":"#display=block;margin=auto;width=600px;"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sign in using your credentials."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Once you have signed in, from the user account dropdown, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Apps"]},"."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/dp-apps-03dc52e971407f18.png","alt":"Developer portal sign in","title":"#display=block;margin=auto;width=400px;"},"children":[]}," ","The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page displays."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create new App"]}," to create a new app. The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Create a new app"]}," page displays."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Type a name for the app, and select the API products you want to associate this app with."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/create-app-bab2baad145a9e63.png","alt":"Create new app","title":"#display=block;margin=auto;width=500px;"},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": When you enter the app name, the Developer portal validates it and display errors if the name contains special or invalid characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create app"]}," to confirm your changes."," ","An API key/secret pair is automatically generated for your app and your newly created app displays on the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page. The details include the API key, secret information, products associated with the API key and the status of the API key and products associated with it."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/new-app-created-e008462f1e953008.png","alt":"App created","title":"#display=block;margin=auto;width=500px;"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A new app is a unique ID and is associated with a specific URL for the portal."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-api-keys","__idx":2},"children":["Manage API keys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the Developer portal, users can create a new API key for a different app/product pairing, update or delete an existing API key."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-key","__idx":3},"children":["Create key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Users can create a new key to associate your app with a different products combination."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a new key:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page, select the app you want to create a new API key for. The selected app details display."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create API key"]}," to display the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Create key"]}," dialog."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/add-new-key-9b5ded5cb20c166c.png","alt":"Add new key","title":"#display=block;margin=auto;width=500px;"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the products you want to uniquely associate to your existing app with this API key, and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create key"]},". A new API key is now created for your app/product pairing."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-key","__idx":4},"children":["Update key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In some cases, users may want to add or remove the products associated with an app. This affects the API key associated with this app/product pairing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To update the key with this information:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page, select the app you want to update the API key for. The selected app details display."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For the API key you want to update, select the vertical menu icon, and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]}," to display the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Update key"]}," dialog."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/edit-key-icon-6ce65eb21eeca534.png","alt":"Edit API key","title":"#display=block;margin=auto;width=500px;"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the product associations to add or remove from the app, and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update key"]},". The API key is now updated with the app and product combination."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-key","__idx":5},"children":["Delete key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Occasionally, users may want to refresh API credentials for an app/product pairing. You can delete an existing API key associated with an existing app."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To delete an API key:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page, select the app you want to delete an API key for. The selected app details display."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For the API key you want to update, select the vertical menu icon, and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete key"]},"."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/delete-key-icon-0d8bfed10cfbab2b.png","alt":"Delete API key","title":"#display=block;margin=auto;width=500px;"},"children":[]}," ","The selected API key is now deleted from the app."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-app","__idx":6},"children":["Manage app"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using Developer portal, users can add multiple apps or edit and delete an existing app. Using the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page, they can also sort the app names alphabetically, or by ascending/descending dates for easier searchability and navigation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"edit-app","__idx":7},"children":["Edit app"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Editing an app allows users to change the display name for clear organization and findability if you have multiple apps set up in your Developer portal."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To edit an app:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page, select the app you want to edit. The selected app details display."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]}," to display the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Change display name"]}," dialog."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter in a new name or make changes, and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save changes"]},"."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/edit-app-name-53d0305ac00afb66.png","alt":"Edit app name","title":"#display=block;margin=auto;width=500px;"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Changing the app name only changes the display name for the app, and does not affect the app/product pairing or the API key value."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-app","__idx":8},"children":["Delete app"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Users can delete an existing app if it is no longer required for the Developer portal."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To delete an app:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page, select the app you want to delete. The selected app details display."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select *",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Delete"]},". The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Delete app"]}," warning dialog displays."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete app"]},"."," ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/delete-app-dialog-1312c8325dab4433.png","alt":"Delete app","title":"#display=block;margin=auto;width=500px;"},"children":[]}," ","The selected app is deleted and removed from your ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["My apps"]}," page."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deleting an app removes its app/product pairings and the API keys."]}]}]},"frontmatter":{"seo":{"title":"Manage apps and API keys using the Developer portal"},"excludeFromSearch":true},"tagList":["admonition"],"title":"Manage apps and API keys using the Developer portal","lastModified":"2025-05-28T16:01:32.000Z"}