Configuring display of API documentation
Specify how and whether the API documentation is displayed.
Required configuration keys:
To configure the display of API documentation
-
Log in to the Administration Portal (see Logging in to the Administration Portal).
-
In the navigation, click Configuration.
-
On the Configuration page, in the Show configuration for the following API project drop-down, select the API Server API project.
-
Expand the Availability of the API documentation configuration key.
-
From the Value drop-down, select how the API documentation is made available:
-
No API documentation: API documentation is not shown.
-
Generate API documentation JSON: The API documentation is saved as a JSON file and can be accessed via the /swagger/swagger.json URL extension (example: https://MeinServer/APIServer/swagger/swagger.json).
-
Show API documentation in UI: The API documentation is shown in the Administration Portal (see Displaying API documentation).
-
In the Value drop-down, enter the maximum number of log entries to save.
-
Click Apply.
-
Perform one of the following actions:
-
If you want to apply the changes locally only, click Apply locally.
-
If you want to apply the changes globally, click Apply globally.
-
Click Apply.
Configuring the Application Governance Module
The Application Governance Module allows you to quickly and simply run the onboarding process for new applications from one place using one tool. An application created with the Application Governance Module combines all the permissions application users require for their regular work. You can assign entitlements and roles to your application and plan when they become available as service items (for example, in the Web Portal).
Detailed information about this topic
Configuring entitlements
To enable identities to view, create, and manage applications in the Web Portal, and also approve requests for application products, assign the following application roles to the appropriate identities:
-
Application Governance | Administrators
-
Application Governance | Owners
-
Application Governance | Approvers
For more information about application roles and how to assign identities to them, see the One Identity Manager Authorization and Authentication Guide.
NOTE: Managing an application involves the following:
-
Editing the application's main data and the assigned entitlements and roles
-
Assigning entitlements and roles to the application
-
Unassigning entitlements and roles from the application
-
Deploying the application and associated entitlements and roles
-
Undeploying the application and its associated permissions and roles
Filling application hyperviews
In the Web Portal, an overview is available to users for each application in the form of a hyperview. The Fill application overview schedule collects all the data for this hyperview and fills it. You can start the schedule and edit it.
For more information about schedule and their properties, see One Identity Manager Operational Guide.
