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 /portal/admin/site-information page.

  2. Configure OAuth2 OpenID Connect (OIDC) authentication. See /portal/technical/deployment/openid-connect.

  3. (Optional) Configure local JWT token provider. See /portal/technical/deployment/local-jwt-provider.


Visit the Colectica REST API v1 documentation page for details.

For interactive documentation for all API methods, visit your Portal’s site: