Page History

This setting is valid for all versions of the API.

This setting is valid for all versions of the client.

You can also access the API Documentation and Download the API definition file here. 

Click API Documentation to access the Swagger UI where you can test the API (refer to Testing APIs for further information).

Displays the Open API definition (Swagger) and allows for making test calls if the API is available.

Downloads the API definition file.

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. 

Click Copy to copy the key to the clipboard.

After a successful creation, your client is displayed in the box below.

Click Next to continue.

Now follow the wizard through some simple steps:

• Create a new client: Enter the name of your client in field Search or create.

Click Create.

If your user has permission to use or create clients in various organizations, a different view will be displayed:

• Field Organization is a drop-down and you can select the organization you want to create a new client in.
• Below, the list of available clients for your user is displayed and you can select one directly.
• If a client has more then one version, you can also select the client version from a drop-down list.

Click Next to continue.

Tab My Clients displays an overview of your clients and their contracts.

Your new client is displayed and labeled as Awaiting Approval. Refer to Handling Approval Requests for detailed information about the approval process in API Management.

As soon as an administrator approved your request, you will get a notification.

Now you can start using the API.

A success message is displayed in the Developer Portal.

If approval is required for the API you subscribed to, you now have to wait for the approval.
If approval is not necessary to use the API, you have now access to it.

If you want to check your newly created client, switch to the My Clients tab.

In step 2, the summary displays the API-related information.

Click Confirm to send your request.

To create a new version, click New Version (refer to The Concepts of API Management > Versioning for detailed information).

Click Learn More on the API that you want to consume.

This will open the API's details.

No matter where you are in the API Management, the Create button is always displayed at the bottom right and opens the creation menu.

In the next step, you need to enter the following mandatory settings:

• Name: Enter a name. The name is not changeable after creation.

• Version: Enter a version number or name.

You can then enter a description. The description is optional and can also be entered or changed later on the details page.

Click Next to continue.

Option Delete is only enabled if you activate the checkbox.

In that case, the organization is already set in the wizard.

In the Plans section, you find all available plans for the API and information on whether approval is required for a plan.

Click Sign Up on the plan you want to register for.

A toast message indicates successful deletion.

This setting is valid for all versions of the plan.

All standard claims, custom claims and ID token fields are available (case sensitive). A special value of access_token will forward the entire encoded token. Nested claims can be accessed by using the JavaScript dot syntax (e.g: address.country, address.formatted).

API Management sets the CORS headers in the following order:

1. CORS headers from the CORS policy have the highest priority.
2. If no CORS policy has been defined, CORS headers from the external API are used.

With PAS 23.1.1, the Scheer PAS installation comes with the default Keycloak client api-management-oauth. Keycloak clients are entities that can request Keycloak to authenticate a user. In most cases, Keycloak clients are applications and services that want to use Keycloak to secure themselves and provide a single sign-on solution. However, clients can also be entities that just want to request identity information or an access token so that they can securely invoke other services on the network.

If you use the Keycloak OAuth policy, we recommend to check against the default client api-management-oauth.

It is stongly recommended to enable this option.

Click Add to create more rows in the table. Click Delete to remove selected rows.

A wizard supports you during policy configuration. Refer to Attaching Policies for a step-by-step guide.