kratos_endpoints

Relevant links

  Submit a bug

  Specification archive

Help us improve this page

Most of this content can be collaboratively discussed and changed in the respective README file.

Contribute

Discuss this interface

Share your thoughts on this interface with the community on discourse

Join the discussion

Charms

Providing kratos_endpoints

Featured charms

How to test a charm

Requiring kratos_endpoints

Featured charms

How to test a charm

Developer documentation

Overview

This relation interface describes the expected behavior of charms claiming to be able to provide or consume a kratos endpoint.

Usage

The interface will provide admin, public, login and sessions endpoints.

Direction

The interface will consist of a provider and a requirer. The provider is expected to supply its public, admin, login and sessions endpoints, while the requirer will just read the information from the application databag.

kratos_admin_endpoint, kratos_public_endpoint

Requirer

Provider

Behavior

Both the requirer and the provider need to adhere to a certain set of criteria to be considered compatible with the interface:

Provider

  • Is expected to serve admin and public API endpoints
  • Is expected to write the public, admin, login and sessions endpoint URLs to the application databag.

Requirer

  • Is expected to consume the relation data to set up integration with Kratos.

Relation Data

Provider

[JSON Schema]

Example

{
  "application_data": {
    "admin_endpoint": "admin-endpoint",
    "public_endpoint": "public-endpoint",
    "login_browser_endpoint": "login-endpoint",
    "sessions_endpoint": "sessions-endpoint"
  }
}

Requirer

Last updated 14 days ago. Help us improve this page.