From the API Server's web interface you can:
Configure the API Server.
Call the swagger documentation for your API.
Open the Operations Support Web Portal.
Call all installed web applications.
To call the API Server web interface
In a web browser, open the webpage (URL) of your API Server.
The API Server stores data securely encrypted on the client.
The certificate is configured when the API server is installed on the IIS. For more information on installing the API Servers, see the One Identity Manager Installation Guide.
For more information about configuring encryption, see the One Identity Manager Web Application Configuration Guide.
Because the API Server is stateless, save the API methods without a client specific state.
For example, you cannot, therefore, define global variables or store session object status data. When the API Server processes are restarted, these values are not restored.
After enabling routes, you cannot change the definition objects anymore.
Use asynchronous code for defining API methods. This supports more efficient usage of server resources and improves performance of the system under load. The methods of the API and the underlying object model convert this asynchronousity using the Task-based Asynchronous Pattern (TAP). For more information about TAP, see https://docs.microsoft.com/de-de/dotnet/standard/asynchronous-programming-patterns/task-based-asynchronous-pattern-tap.
Do not use the HttpContext.Current method when you define API methods. You can query the current HTTP requirements with the QBM.CompositionApi.OwinRequestScopeContext.Context.Current static method.
If you define API methods that modify data, do NOT use the GET method.
In this chapter, you will find general policies and conventions, which you must take into account when you create an API.
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center
