Important Note
This space contains files and text snippets that are used throughout the Scheer PAS documentation.
This content is not meant to be read independently from the rest of the documentation.
- Created by Kirstin Seidel-Gebert, last modified by Annegret Bernhardt on Aug 08, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 119 Next »
Some API Management excerpts are saved within the documenation, see API Management excerpts managed directly in the documentation for an overview.
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Group | Name | Excerpt | Usage | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Administration | 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":
Thus, you need to have to separate admin accounts: one for Identity Management, and one for API Management. | ||||||||||
Administration | test_gateway_nok | If the configuration is invalid, an error message will be shown including further information about the error itself: | ||||||||||
Administration | test_gateway_ok | If the gateway configuration is correct, you will get a success message: | ||||||||||
APIs | 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:
For detailed information about the visibility concept, visit page The Concepts of API Management. |
| |||||||||
APIs | testing_api_with_swagger | Testing of API configurations is only possible with REST APIs that are coming with a Swagger file. | ||||||||||
Clients | api_registered_client | 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 | For more information about the functions of the Swagger UI, go to the Swagger homepage. | ||||||||||
Developer Portal | corresponding_message_in_portal | The user gets a corresponding notification in the API Developer Portal. | ||||||||||
Developer Portal | 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 | 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 | approver_confirmation | For security reasons, the approver needs to confirm his choice. | ||||||||||
Developer Portal | confirm_deletion | For security reasons, you need to confirm the deletion. | ||||||||||
Developer Portal | 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. | ||||||||||
Developer Portal | exposing_api_types DEPRECATED WITH 22.1.1 - delete after publication of this version | You can expose all forms of APIs in the Developer Portal:
| ||||||||||
Developer Portal | testing_apis DEPRECATED WITH 22.1.1 - delete after publication of this version | Further below on the documentations page you can find the Swagger UI. Use it to send test requests to the API. Enter test data and execute a request. For more information about the functions of the testing UI, refer to the Swagger pages. | ||||||||||
General Notes, Infos, Tips | api_displayed_when_published | This tab is only visible for published APIs. |
| |||||||||
General Notes, Infos, Tips | api_displayed_when_registered | This tab is only visible for registered clients. | ||||||||||
General Notes, Infos, Tips | api_link_to_policy_page | On page Policies you can find an overview of the standard policies supplied with Scheer PAS API Management. Page Assigning Policies shows how to configure a policy. | ||||||||||
General Notes, Infos, Tips | api_my_all_hint | 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 | Do not forget to click the Save button when you have finished. |
| |||||||||
General Notes, Infos, Tips | api_version_number_note | 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 | Click | ||||||||||
General Notes, Infos, Tips | note_read_confirmation_dialog | Please read the confirmation dialog carefully. | ||||||||||
General Notes, Infos, Tips | use_breadcrump | Use the breadcrumb menu at the top of the page for guidance. |
| |||||||||
Metrics | tipp_elaborated_metrics | 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 | 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 | By default, only users with role Administrator can create new organizations. This is a customizable option, see Administration Guide > Customizing PAS. | ||||||||||
Plans | locked_plans | Once a plan is locked, it cannot be revised anymore. However, you can still create a new version of this plan. | ||||||||||
Policies | api_behind_proxy | Please disable the TLS check if you are using Scheer PAS 21.1 or a newer version, because all PAS components are running behind a proxy server. | ||||||||||
Policies | api_blacklist_whitelist | An IP Blocklist policy overrides an IP Allowlist policy. | ||||||||||
Policies | api_enable_option | It is strongly recommended to enable this option. | ||||||||||
Policies | api_move_policies | The order of the policies is important. The order in which the policies appear in the user interface determines the order they will be applied at runtime. You can drag a policy up and down the list to change the order: | ||||||||||
Policies | api_no_ipv6 DEPRECATED WITH 22.1.1 (can be deleted after this version is published) | The use of IPv6 is neither possible in the blacklist nor in the whitelist policy. |
| |||||||||
Policies | cors_policy_chain | API Management sets the CORS headers in the following order:
| ||||||||||
Policies | proxy_x_real | In the default setup the gateway runs behind a proxy. In the default scenario there is no need to add the header X-Real-IP in the custom header field IP Address HTTP Header. | ||||||||||
Policies | swagger_definition_changes | Adding or removing policies does not enrich the Open API documentation. You need to adjust your documentation manually. | ||||||||||
Support | support_overview |
| ||||||||||
Terms & Definitions | api_contracts_and_keys | API Contracts and API KeysOnly public APIs can be accessed by any consumer. The only way for a client to consume a private API is by using an API contract. An API contract is a link between a client and an API through a plan offered by that API. API contracts can only be created between clients and published APIs which are offered through at least one plan. An API contract cannot be created between a client and a public API. When an API contract is created, the system generates a unique API Key. This key is unique per client and the same for all contracts of this client. All requests made to the API by a client through the gateway must include this API Key. The API Key is used to create the runtime policy chain from the policies configured on the API, plan and client. You can forward the X-API-Key to the service using the API Key policy. However, you cannot define your own value for the X-API-Key, since the gateway uses the key to identify the clients. | ||||||||||
Terms & Definitions | definition_api | APIs in API Management represent real back-end APIs (Application Programming Interfaces). An API is also known as a service, meaning anything that can be invoked remotely by some sort of client. API Management provides a way to turn unmanaged (raw) back-end APIs into managed APIs by attaching policies to them. Every managed API can be published as Public API or Private API or both:
In API Management, users can create new APIs manually or easily import them from the API Catalog. | ||||||||||
Terms & Definitions | definition_client | The client is the consumer of the API:
| ||||||||||
Terms & Definitions | definition_contract | A contract relates a client to an API, using a plan. | ||||||||||
Terms & Definitions | definition_organization | Almost everything in the API Management data model exists in the context of an organization:
| ||||||||||
Terms & Definitions | definition_plan | A plan is a set of policies that defines the level of service API Management provides for an API.
| ||||||||||
Terms & Definitions | definition_policy | Policies are at the lowest level of the data model, but they are the most important concept: A policy is a rule or a set of rules API Management uses to manage access to your APIs.
|
API Management excerpts managed directly in the documentation
Chapter | Excerpt Name | Page of the Original | (Re-)Usage |
---|---|---|---|
Administration | data_export | ||
Administration | backup | ||
Administration | data_import | ||
Administration | restore | ||
Administration | keycloak_login |
| |
Policies | definition | ||
Policies | policy_overview_table | ||
Policies | info_post_requests |
| |
Metrics | api_metrics | ||
Metrics | client_metrics | Metrics |
- No labels