Skip to content

Commit

Permalink
Merge pull request #7467 from shnrndk/master
Browse files Browse the repository at this point in the history
Add doc for change api provider
  • Loading branch information
npamudika authored Jan 19, 2024
2 parents 083cd2a + 75da175 commit f0a687a
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 0 deletions.
Binary file added en/docs/assets/img/learn/api-chris.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Changing the Provider of an Api

If required, you can transfer the ownership of your api to another user in your organization. Thereby, when transferring ownership, the new provider/owner will have the required permission to delete or edit the respective api.

For example, let's consider that **Chris** and **Kim** are in the same organization and that **Kim** owns testApi and he wants to transfer the ownership of testApi to **Chris**.

Follow the instructions below to change the ownership of an application:

1. Start the WSO2 API-M Server.
2. If the users do not exist in the system, create them.

1. Sign in to the WSO2 API-M Management Console.

`https://<APIM-hostname>:9443/carbon`

2. Create two users named **Chris** and **Kim** with the `Internal/subscriber` role.
Refer [Create New Users]({{base_path}}/administer/managing-users-and-roles/managing-users#adding-a-new-user) for more information.

3. We can check the current provider by logging to the publisher portal and by looking at the api tiles.

1. Sign in to the WSO2 API-M Publisher Portal using the api owner's (Kim's) user credentials.

`https://<APIM-hostname>:9443/publisher`

2. If the apis does not exist, create it in the Publisher Portal.

4. Change the owner/provider of the api.

1. Sign in to the WSO2 API-M Admin Portal using admin credentials.

`https://<APIM-hostname>:9443/admin`

2. Click **Change Api Provider** under **Settings**.
This shows you the list of apis together with the respective providers.

3. Search for the apis that you want to change and click **Edit**.
[![Search for the api]({{base_path}}/assets/img/learn/changing-api-provider-search.png)]({{base_path}}/assets/img/learn/changing-api-provider-search.png)

4. Update the **Provider** field with the new provider's username (Chris).

!!! Troubleshooting
If you get a "`Not a valid user `" error (e.g., Chris123 not is a valid user) in the Admin Portal, make sure to request that specific user (e.g., Kim) by checking the spellings.


The apis page shows the new ownership.

[![Api page with the new ownership]({{base_path}}/assets/img/learn/changing-api-provider.png)]({{base_path}}/assets/img/learn/changing-api-provider.png)

Now, when Kim or Chris signs in to the publisher Portal, the provider name is changed to Chris.
[![Kim Application List]({{base_path}}/assets/img/learn/api-chris.png)]({{base_path}}/assets/img/learn/api-chris.png)
1 change: 1 addition & 0 deletions en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,7 @@ nav:
- Advanced Topics:
- Add Custom Attributes to Applications: consume/manage-application/advanced-topics/add-custom-attributes-to-applications.md
- Change the Owner of an Application: consume/manage-application/advanced-topics/changing-the-owner-of-an-application.md
- Change the Provider of an Api: consume/manage-application/advanced-topics/changing-the-provider-of-an-api.md
- Add an Application Creation Workflow: consume/manage-application/advanced-topics/adding-an-application-creation-workflow.md
- Add an Application Key Generation Workflow: consume/manage-application/advanced-topics/adding-an-application-key-generation-workflow.md
- Manage Subscriptions:
Expand Down

0 comments on commit f0a687a

Please sign in to comment.