Management API

• Management API documentation
• User API examples
• OpenAPI and Swagger
• Filtering
• External Permissions API
• Management API Client Credentials
• Simple usage examples
• Authorisations

The Management API is a RESTful API through which many big and small management tasks can be done. It serves as an alternative to using the various User Interfaces the onePortal platform comes with.

The most current API documentation can be found under the /apidoc URI in your onePortal installation, for example https://example.com/apidoc. That documentation is interactive and can be used to perform the various actions with proper credentials, if necessary.

Use of the API requires credentials. These credential types are supported:

• Management API client key and secret, used with Basic authentication scheme. The API Client Registration must usually have some specific permissions, depending on the API being used.
• OpenID Connect access token, used as a bearer token. The user whose access token is used must usually have some specific permissions, or the user must match the targeted action, depending on the API being used.

Some parts of the API support using either credential, some support only one. See the API documentation for current details.