---
title: Charmhub | login_ui_endpoints interface
description: Interfaces describe the relation between two charms. This interface shows
  opinionated, standardized interface specifications for charm relations.
url: https://charmhub.io/integrations/login_ui_endpoints
---

# login\_ui\_endpoints

## Overview

This relation interface describes the expected behavior of charms claiming to be able to provide or consume Identity Platform Login UI endpoints.

## Usage

The interface will provide publicly accessible endpoints. These endpoints include the URL intended as the default for browsers, as well as specific endpoints for the Ory Hydra and Kratos applications.

## Endpoints

The full list of endpoints provided by login\_ui\_endpoints provider is the following:

* consent\_url
* error\_url
* index\_url
* login\_url
* oidc\_error\_url
* registration\_url
* default\_url

## Direction

The interface will consist of a provider and a requirer. The provider is expected to supply its endpoints,
while the requirer will just read the information from the application databag. For the full list of endpoints, please refer to the Endpoints section.

```
flowchart
    Requirer ----> Provider
    Provider -- default_url, consent_url... --> Requirer
```

## 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 Identity Platform Login UI endpoints.
* Is expected to write the URLs to the application databag.

### Requirer

* Is expected to consume the relation data to set up integration with Identity Platform Login UI endpoint.

## Relation Data

[[Pydantic Schema]](https://github.com/canonical/charmlibs/blob/main/interfaces/login_ui_endpoints/interface/vv0/schema.py)

## Charms implementing this interface

### Providers

* [identity-platform-login-ui-operator](https://charmhub.io/identity-platform-login-ui-operator)

### Requirers

## Other charms using this interface

### Providers

* [identity-platform-login-ui-operator](https://charmhub.io/identity-platform-login-ui-operator)

### Requirers

* [kratos](https://charmhub.io/kratos)
* [hydra](https://charmhub.io/hydra)