OpenAPI and Swagger

An OpenAPI 3.0 specification is automatically generated and is openly available. It can be browsed and tested with the Swagger UI tool. In the Swagger UI you can find links back to this documentation for more discussion on some of the topics.

It is also possible to test the APIs with sufficient credentials. Just select the button "Authorize" or click one of the lock buttons on the right.

Goto service base address https://your-id-service/apidoc to view the latest API documentation. An example may be viewed here: https://oneportal.t5.fi/apidoc/

In the documentation, it is possible to sign-in to test the APIs. That this by first selecting:

You will then see a popup requesting credentials. It is possible to use both BASIC authentication, and OAUTH2 authentication.