Configure the REST API

Colectica Portal exposes the functionality of Colectica Repository by providing a REST-style API. By default, the API is disabled. To enable the API, follow these steps:

1. As an administrator, enable the API in the Configuration.

2. Configure OAuth2 OpenID Connect (OIDC) authentication. See Configure OAuth2 OpenID Connect (OIDC).

3. (Optional) Configure local JWT token provider. See Configure Local JWT Token Provider (Optional).

Note

Visit the Colectica REST API v1 documentation page for details.

For interactive documentation for all API methods, visit your Portal’s site: http://example.org/swagger/ui.