An application always needs to have at least one owner. The owner of an application is allowed to perform all kinds of operations on the application, e.g. subscribe to APIs, unsubscribe APIs, add and delete owners, and delete/unregister the application altogether.
In addition to the owners of the application, there may be others which can interact with the application definition: Collaborators and Readers.
In many, if not most, use cases, a developer does not work alone on "his application", but is part of a team. In those cases, it may be necessary to share the knowledge of API keys/secret among multiple developers. The API Portal supports those cases via the notion of "application owners".
Description | |
---|---|
Owner | The owner of an application is usually the developer which originally registered the application in the API Portal. The original owner can add additional owners to the application (from the application's specific page). Further owners have exactly the same rights as the original owner. |
Collaborator | A collaborator for an application can subscribe to APIs and unsubscribe on behalf of the application. A collaborator cannot add other collaborators or owners to the application. Only owners can do that. |
Reader | Readers of an application can view the subscriptions (API Keys/Secrets) of an application, but can neither add owners or collaborators nor change the API subscriptions. |
Note: If a developer/portal user belongs to an Admin group, he/she will be treated with the same rights to the Application as an Application Owner.
The following matrix shows which rights an owner, collaborator or reader of an application has:
Rights description | Reader | Collaborator | App Owner | Admin |
---|---|---|---|---|
View subscriptions/credentials | ||||
Subscribe to APIs | - | |||
Unsubscribe an API | - | |||
Add owners, collaborators and readers | - | - | ||
Delete owners, collaborators and readers | - | - | ||
Unregister Application | - | - |
In order to add an owner, collaborator or reader to an application, open the application's page (select the correct one from your applications), click "Owners", and subsequently "Register Additional Owner". Note: You can only add owners, collaborators or readers to an application if you are the owner of the application, or if you are an Admin on the API Portal.
The additional owner must already be registered with the API Portal, and you need to know the owner's email address (the email address the new owner used to register with the API portal). Then select the role you want the new owner to have on the application: Owner, Collaborator or Reader.
Important: If you make the new owner a Co-Owner of the application, this means he has exactly the same rights as you have, including the possibility to remove you as an owner of the application. Owners are all equal in rights.
In order to transfer ownership of an application, perform the following steps:
Removing the previous owner of the application can either be done by the previous owner himself, or by the new owner after he/she has been made co-owner. Note that it's not possible to remove a single owner with the "owner" role. An application always has to have at least one owner.