Group | Name | Excerpt | Usage |
---|
Administration | manage_users |
Multiexcerpt |
---|
MultiExcerptName | manage_users |
---|
| API Management uses the Identity Management to manage its users. This tool can manage users for multiple applications. Data for each application is stored in so called "realms": - Users of Identity Management itself are stored to realm Master.
- Users of API Management and Log Analyzer are stored to realm Apiman.
Thus, you need to have to separate admin accounts: one for Identity Management, and one for API Management. |
| |
Administration | test_gateway_nok |
Multiexcerpt |
---|
MultiExcerptName | test_gateway_nok |
---|
| If the configuration is invalid, an error message will be shown including further information about the error itself: ![gateway_invalid.png](/plugins/servlet/confluence/placeholder/unknown-attachment?locale=en_US&version=2)
|
| |
Administration | test_gateway_ok |
Multiexcerpt |
---|
MultiExcerptName | test_gateway_ok |
---|
| If the gateway configuration is correct, you will get a success message: ![gateway_valid.png](/plugins/servlet/confluence/placeholder/unknown-attachment?locale=en_US&version=2)
|
| |
APIs | api_visibility
|
Multiexcerpt |
---|
MultiExcerptName | api_visibility |
---|
| Use the drop-down list to define which user group can browse the API and the corresponding plan. This affects the view in the API Management itself as well as in the API Developer Portal: - Organization Members (default): All members of the organization. The PAS user must be listed in one of the Identity Management groups API-Management-Users, API-Management-Administrators or API-Management-Developer-Portal-Users.
- API Management Users: Any PAS user listed in Identity Management groups API-Management-Users or API-Management-Administrators.
- API Developer Portal Visitors: Any PAS user listed in Identity Management group API-Management-Developer-Portal-Users and any user who visits the API Developer Portal, whether logged in or not.
For detailed information about the visibility concept, visit page The Concepts of API Management. |
| |
APIs | testing_api_with_swagger |
Multiexcerpt |
---|
MultiExcerptName | testing_api_with_swagger |
---|
|
Info |
---|
Testing of API configurations is only possible with REST APIs that are coming with an OpenAPI Specification. |
|
| |
Clients | api_registered_client |
Multiexcerpt |
---|
MultiExcerptName | api_registered_client |
---|
|
Note |
---|
Before the client is registered with the runtime gateway, it is not possible to make requests to backend APIs on behalf of that client. |
|
| |
Clients | swagger_ui |
Multiexcerpt |
---|
MultiExcerptName | swagger_ui |
---|
|
Tip |
---|
For more information about the functions of the Swagger UI, go to the Swagger homepage. |
|
| |
Developer Portal | api_doc_and_definition
|
Multiexcerpt |
---|
MultiExcerptName | api_doc_and_definition |
---|
| The API Documentation button and a button to download the API definition file are also available here. |
| |
Developer Portal | api_documentation_button
|
Multiexcerpt |
---|
MultiExcerptName | api_documentation_button |
---|
| The API Documentation button grants access to the Swagger UI where the user can test the API (refer to Testing APIs for further information). |
| |
Developer Portal | api_version_label |
Multiexcerpt |
---|
MultiExcerptName | api_version_label |
---|
| If more than one version of the API is available, the latest version will be displayed on top. To see the details of earlier versions, expand the labels below the open details page. |
| |
Developer Portal | approver_confirmation
|
Multiexcerpt |
---|
MultiExcerptName | approver_confirmation |
---|
| For security reasons, the approver needs to confirm his choice. |
| |
Developer Portal | confirm_deletion |
Multiexcerpt |
---|
MultiExcerptName | confirm_deletion |
---|
| For security reasons, you need to confirm the deletion. |
| |
Developer Portal | copy_to_clipboard
|
Multiexcerpt |
---|
MultiExcerptName | copy_to_clipboard |
---|
| Use icon to copy the key to the clipboard. |
| |
Developer Portal | corresponding_message_in_portal
|
Multiexcerpt |
---|
MultiExcerptName | corresponding_message_in_portal |
---|
| The user gets a corresponding notification in the API Developer Portal. |
| |
Developer Portal | description_api_definition_download |
Multiexcerpt |
---|
MultiExcerptName | description_api_definition_download |
---|
| Downloads the API definition file. |
| |
Developer Portal | description_api_documentation
|
Multiexcerpt |
---|
MultiExcerptName | description_api_documentation |
---|
| Displays the Open API definition (Swagger) and allows for making test calls if the API is available. |
| |
Developer Portal | details_page_public
|
Multiexcerpt |
---|
MultiExcerptName | details_page_public |
---|
| On the details page of a Public API, users can find further information about the API such as an extended description and the public endpoint. |
| |
General Notes, Infos, Tips | api_displayed_when_published |
Multiexcerpt |
---|
MultiExcerptName | api_displayed_when_published |
---|
|
Info |
---|
This tab is only visible for published APIs. |
|
| |
General Notes, Infos, Tips | api_displayed_when_registered |
Multiexcerpt |
---|
MultiExcerptName | api_displayed_when_registered |
---|
|
Info |
---|
This tab is only visible for registered clients. |
|
| |
General Notes, Infos, Tips | api_link_to_policy_page |
Multiexcerpt |
---|
MultiExcerptName | api_link_to_policy_page |
---|
|
|
| |
General Notes, Infos, Tips | api_my_all_hint |
Multiexcerpt |
---|
MultiExcerptName | api_my_all_hint |
---|
|
Info |
---|
If you want to edit API Management elements, you need to access them via the My... menu items (see "My" API Management items). |
|
| |
General Notes, Infos, Tips | api_save_when_finished |
Multiexcerpt |
---|
MultiExcerptName | api_save_when_finished |
---|
| Do not forget to click the Save button when you have finished. |
| |
General Notes, Infos, Tips | api_version_number_note |
Multiexcerpt |
---|
MultiExcerptName | api_version_number_note |
---|
|
Info |
---|
You can enter numbers and text in the Version field which allows the use of version numbers (e.g. 1.0, 2.1 ...) as well as version descriptions (e.g. Gold, Super etc.). |
|
| |
General Notes, Infos, Tips | api_work_with_items |
Multiexcerpt |
---|
MultiExcerptName | api_work_with_items |
---|
| Click to add a new item to a list, click to show/hide the list of items. |
| |
General Notes, Infos, Tips | note_read_confirmation_dialog |
Multiexcerpt |
---|
MultiExcerptName | note_read_confirmation_dialog |
---|
|
Note |
---|
Please read the confirmation dialog carefully. |
|
| |
General Notes, Infos, Tips | use_breadcrump
|
Multiexcerpt |
---|
MultiExcerptName | use_breadcrump |
---|
|
Tip |
---|
Use the breadcrumb menu at the top of the page for guidance. |
|
| |
Metrics | tipp_elaborated_metrics
|
Multiexcerpt |
---|
MultiExcerptName | tipp_elaborated_metrics |
---|
|
Tip |
---|
PAS 22.1 For more elaborated metrics, have a look at the Log Analyzer which offers a default dashboard visualizing API Management insights. |
|
| |
Notifications | info_enable_mail_notifications |
Multiexcerpt |
---|
MultiExcerptName | info_enable_mail_notifications |
---|
|
Info |
---|
The notifications can also be sent by by email. This feature must be enabled during the the setup of your Scheer PAS installation. Ask your Scheer PAS administrator for help. |
|
| |
Organizations | api_org_creation deprecated - delete when doc version 22.2 has been published | Multiexcerpt |
---|