Skip to content

W-18087403 Exchange: client app management jh #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 25 commits into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
1a5a868
added missing info
JennyHajee Mar 28, 2025
8b20492
added missing JTBD
JennyHajee Mar 31, 2025
403fe53
added missing tasks for my app
JennyHajee Apr 1, 2025
02742f8
New content for adding owners
JennyHajee Apr 4, 2025
826dd71
edits
JennyHajee Apr 7, 2025
d0ed84a
edits
JennyHajee Apr 7, 2025
77b37e4
changed add SLA Tier to Add and change an SLA tier
JennyHajee Apr 7, 2025
7d5fe2d
change my applications heading to Manage Client Applications
JennyHajee Apr 7, 2025
c5be71c
edits
JennyHajee Apr 7, 2025
dc2f688
added view usage info
JennyHajee Apr 8, 2025
7e14f66
edits
JennyHajee Apr 8, 2025
3f5b97c
edits
JennyHajee Apr 9, 2025
94763a5
edits
JennyHajee Apr 15, 2025
049b32c
edits
JennyHajee Apr 15, 2025
35267ba
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
125a75d
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
ebaf858
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
3a7198d
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
9a41125
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
e0bacad
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
d02c35f
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
4bfc342
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
8776eba
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
2dd12f5
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
e9685a9
Update modules/ROOT/pages/about-my-applications.adoc
JennyHajee May 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
** xref:asset-usage-and-engagement-metrics-dashboard.adoc[Asset Usage and Metrics Dashboard]
** xref:metrics-for-a-specific-asset-version.adoc[Metrics for a Specific Asset and Version]
* xref:about-api-use.adoc[Consume an API]
** xref:about-my-applications.adoc[My Applications]
** xref:about-my-applications.adoc[Manage Client Applications]
** xref:to-request-access.adoc[Request Access]
** xref:to-deploy-using-rest-connect.adoc[REST Connect Connector Generator]
* xref:about-platform-apis.adoc[Exchange Platform APIs]
Expand Down
89 changes: 76 additions & 13 deletions modules/ROOT/pages/about-my-applications.adoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,13 @@
= My Applications
= Manage Client Applications
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]
:imagesdir: ../assets/images/

The *My Applications* area in the Exchange details view for an asset lists
applications that hold a contract with an API or an API Group.
Manage your client applications by using the *My Applications* page. This page lists applications that hold a contract with an API or an API group. To view this page, select *My applications* from the navigation bar.

image::ex2-my-applications.png[]

Each client application has a client ID, client secret, description, URL, redirect URIs,
grant types, and a usage dashboard.

The usage information enables you to set the verification duration. If not specified,
the range is the previous eight days. The usage lists total number of requests to
the API, average latency, error rate, and graphs for total requests,
requests by HTTP status code, and error percentage.

Applications in *My Applications* are registered using API Manager in Anypoint Platform.
Applications are registered using API Manager in Anypoint Platform.

To register a client application to an existing API or API Group, the client application
must first request access. When the request is approved by the API or API Group owner, a
Expand All @@ -39,6 +29,79 @@ API or API Group instance. An API consumer can use the Exchange *My Applications
the contracts created between an API instance or API Group instance and that consumer's client
applications.

== View Client Applications Details

Each client application has a client ID, client secret, description, URL, redirect URIs,
grant types, and usage dashboard.

To see the details of a client application, select *My application* from the navigation bar and select an application from the list.

To find an application, search the list of applications by entering a name or description in *Search* and press *Enter*.


== Edit Client Application Details
You can change the client application details. These include name, description, URL, and OAuth 2.0 redirect URIs.

To make changes, click *Edit*. After making your updates, click *Update* to save your changes.

== Delete a Client Application
When you don't need the contract for an application, you can delete it. After the application is deleted, there's no longer a contract with the application and you can’t access it. To regain access, request access to the API again.

. From the navigation bar, select *My applications* and click the name of the application.
. Click image:ex2-more-options-icon.png[The more options icon,1%,1%] and select *Delete application*.
. Confirm that you want to delete the application by clicking *Delete application*.

== Reset Client Secret
You can reset the client secret for an application on a set schedule to ensure security, even if users leave the company. Resetting the secret also ensures it isn't unintentionally shared with unauthorized users.

Applications using the current client secret can’t access any of the APIs with which they were registered.

. From the navigation bar, select *My applications* and click the name of the application.
. Click image:ex2-more-options-icon.png[The more options icon,1%,1%] and select *Reset client secret*.
. Confirm that you want to delete the application by clicking *Reset client secret*.
+
The client secret is reset. In the application details section, click *Show* to see the new client secret.

== Add Users as Client Application Owners
After a user is granted to an API a client application is created. The owner of the application is the also the owner of the new client application. The owner can add more users as owners from Exchange.

. From the navigation bar in Exchange, select *My applications* and click the name of the application.
. Select the *Manage Owners* tab and enter a user's email, name, or team name in *Search*.
. From the search results, select the user you want to add.
+
The selected user is added to the list of owners for the application.

== Delete Client Application Owners
You can remove an owner of a client application.

. From the navigation bar in Exchange, select *My applications* and click the name of the application.
. Select the *Manage Owners* tab, locate the owner in the list, and click image:ex-trash-can-icon.png[3%,3%].

== Add and Change an SLA Tier
SLA tiers are defined in API Manager. If an application doesn't have an SLA tier listed, you can request to add an SLA tier. You can also change the SLA tier for an application. The available SLA tiers are set by an admin in API Manager. The owner of the API instance must approve the request to add or change the tier level.

To add or change an SLA tier:

. From the navigation bar in Exchange, select *My applications* and click the name of the application.
. From the instances panel, move the cursor over an instance and click *View SLA Tier*.
. Click *Manage SLA Tiers*, select an SLA tier, and click *Submit*.

== View Usage Information
See usage information for the instances of a client application using the application dashboard. The dashboard shows graphs for:

* Total requests
* Average latency (ms)
* Requests by status code
* Requests by HTTP status code
* Error percentage

You can set a date range to display for all the charts in your dashboard. If not specified,
the range is the previous eight days.

. From the navigation bar in Exchange, select *My applications* and click the name of the application.
. Select one of more instance.
. Click the calendar dropdown, select a date range, and click *Confirm*.

== See Also

* xref:to-request-access.adoc[Request Access]
2 changes: 1 addition & 1 deletion modules/ROOT/pages/to-customize-portal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you need to revert portal customizations back to their default settings, use
* Text color (active): #00A2DF
* https://cdn.anypoint.mulesoft.com/artifacts/exchange-ui/images/hero-image-default.png[Welcome section Hero image]
+
*Note:* Open the image in a browser and right click to save the image to your computer. In Exchange, you can upload
NOTE: Open the image in a browser and right click to save the image to your computer. In Exchange, you can upload
the image to replace the image in your portal from the image on your computer.
+
* Welcome section text color: #FFFFFF
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/to-request-access.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ secret credentials are automatically created when the client application is
registered.

An instance owner can use API Manager to view all API contracts ever created for an
API instance or API Group instance. An API or API Group consumer can use the Exchange *My Applications* page to view
API instance or API Group instance. An API or API Group consumer can use the *My Applications* page in Exchange to view
the API contracts created between an API instance or API Group instance and that consumer's client
applications.

Expand All @@ -37,7 +37,7 @@ conditions.
An application and its instance use the same client provider. If an organization administrator has configured xref:api-manager::configure-multiple-credential-providers.adoc[multiple client providers] in Anypoint API Manager, then the application list shows only the applications that use the same client provider as the selected instance.
. If you do not have an application to which to provide access, click *Select application > Create a new application*.
+
See the section "Create a new application" for more information.
For more information, see the Create a New Application section.
. Choose the service-level agreement (SLA) value for the application.
. Click *Request access*.
+
Expand Down