OpenAPI Specs

Akkess REST APIs are documented using

OpenAPI specifications.

Entity APIs

Actor API

Swagger

The Actor API is used for CRUD operations on actors.

https://api.akkess.io/actor/v1/openapi.yaml

Node API

Swagger

The Node API is used for CRUD operations on nodes.

https://api.akkess.io/node/v1/openapi.yaml

IAM APIs

Authentication API

Swagger

The Authentication API is used for issuing and validating tokens.

https://api.akkess.io/authentication/v1/openapi.yaml

Identity provider API

Swagger

The Identity provider API is used for managing identity providers.

https://api.akkess.io/idp/v1/openapi.yaml

OAuth2 API

Swagger

The OAuth 2 API is used for interacting with OAuth2 identity providers

https://api.akkess.io/oauth2/v1/openapi.yaml

Firewall API

Swagger

The Firewall API is used for managing firewall rules.

https://api.akkess.io/firewall/v1/openapi.yaml

Policy API

Swagger

The Policy API is used for managing services, permissions and roles.

https://api.akkess.io/policy/v1/openapi.yaml

Account API

Swagger

The Account API is used for managing accounts.

https://api.akkess.io/account/v1/openapi.yaml

Application API

Swagger

The Application API is used for managing applications.

https://api.akkess.io/application/v1/openapi.yaml

Tenant API

Swagger

The Tenant API is used for managing tenants.

https://api.akkess.io/tenant/v1/openapi.yaml

Administrator API

Swagger

The Administrator API is used for CRUD operations on administrators for Account, Application and Tenant.

https://api.akkess.io/administrator/v1/openapi.yaml

Supporting APIs

Basic IdP API

Swagger

The Basic IdP is a simple identity provider for testing purposes only.

https://api.akkess.io/basic-idp/v1/openapi.yaml