# backplane_oauth v1.10.77 - Table of Contents

> OAuth 2.0 and OpenID Connect provider core for Backplane, forked from Boruta

## Pages

- [Backplane OAuth](readme.md)
- [Changelog](changelog.md)

## Modules

- [Backplane.Oauth](Backplane.Oauth.md): OAuth requests entrypoint, provides authorization artifacts to clients as stated in [RFC](https://datatracker.ietf.org/doc/html/rfc6749#section-4).
- [Backplane.Oauth.AccessTokens](Backplane.Oauth.AccessTokens.md): Access token context

- [Backplane.Oauth.AccessTokensAdapter](Backplane.Oauth.AccessTokensAdapter.md): Encapsulate injected `Backplane.Oauth.AccessTokens` adapter in context configuration

- [Backplane.Oauth.Application](Backplane.Oauth.Application.md): Implement this behaviour in the application layer of your OAuth / OpenID Connect provider.
This behaviour gives all callbacks triggered invoking `Backplane.Oauth` module functions.
- [Backplane.Oauth.Authorization](Backplane.Oauth.Authorization.md): OAuth requests authorization

- [Backplane.Oauth.Authorization.AccessToken](Backplane.Oauth.Authorization.AccessToken.md): Check against given params and return the corresponding access token

- [Backplane.Oauth.Authorization.Client](Backplane.Oauth.Authorization.Client.md): Check against given params and return the corresponding client

- [Backplane.Oauth.Authorization.Code](Backplane.Oauth.Authorization.Code.md): Check against given params and return the corresponding code

- [Backplane.Oauth.Authorization.Nonce](Backplane.Oauth.Authorization.Nonce.md): Check OpenID Connect nonce against given request

- [Backplane.Oauth.Authorization.ResourceOwner](Backplane.Oauth.Authorization.ResourceOwner.md): Check against given params and return the corresponding resource owner

- [Backplane.Oauth.Authorization.Scope](Backplane.Oauth.Authorization.Scope.md): Check against given params and return the corresponding scopes

- [Backplane.Oauth.AuthorizationCodeRequest](Backplane.Oauth.AuthorizationCodeRequest.md): Authorization code request

- [Backplane.Oauth.AuthorizationSuccess](Backplane.Oauth.AuthorizationSuccess.md): Struct encapsulating an authorization success data

- [Backplane.Oauth.AuthorizeApplication](Backplane.Oauth.AuthorizeApplication.md): OAuth application behaviour - authorize endpoint
- [Backplane.Oauth.AuthorizeResponse](Backplane.Oauth.AuthorizeResponse.md): Response returned in case of authorization request success. Provides utilities and mandatory data needed to respond to the authorize part of implicit, code and hybrid flows.

- [Backplane.Oauth.BasicAuth](Backplane.Oauth.BasicAuth.md): HTTP BasicAuth utilities
- [Backplane.Oauth.BearerToken](Backplane.Oauth.BearerToken.md): OAuth bearer token utilities
- [Backplane.Oauth.Cache](Backplane.Oauth.Cache.md): Backplane OAuth Ecto adapter uses [Nebulex](https://github.com/cabol/nebulex) in order to cache entities

- [Backplane.Oauth.Cache.Primary](Backplane.Oauth.Cache.Primary.md): This is the cache for the primary storage.

- [Backplane.Oauth.Client](Backplane.Oauth.Client.md): OAuth client schema and utilities

- [Backplane.Oauth.ClientCredentialsRequest](Backplane.Oauth.ClientCredentialsRequest.md): Client credentials request

- [Backplane.Oauth.Clients](Backplane.Oauth.Clients.md): Client context

- [Backplane.Oauth.ClientsAdapter](Backplane.Oauth.ClientsAdapter.md): Encapsulate injected `Backplane.Oauth.Clients` adapter in context configuration

- [Backplane.Oauth.CodeRequest](Backplane.Oauth.CodeRequest.md): Code request

- [Backplane.Oauth.Codes](Backplane.Oauth.Codes.md): Code context

- [Backplane.Oauth.CodesAdapter](Backplane.Oauth.CodesAdapter.md): Encapsulate injected `Backplane.Oauth.Codes` adapter in context configuration

- [Backplane.Oauth.Config](Backplane.Oauth.Config.md): Utilities to access Backplane OAuth configuration ad set defaults.
- [Backplane.Oauth.Ecto.Admin](Backplane.Oauth.Ecto.Admin.md): Administration of Backplane OAuth resources.

- [Backplane.Oauth.Ecto.Admin.Clients](Backplane.Oauth.Ecto.Admin.Clients.md): `Backplane.Oauth.Ecto.Client` resource administration

- [Backplane.Oauth.Ecto.Admin.Scopes](Backplane.Oauth.Ecto.Admin.Scopes.md): `Backplane.Oauth.Ecto.Scope` resource administration

- [Backplane.Oauth.Ecto.Admin.Tokens](Backplane.Oauth.Ecto.Admin.Tokens.md): `Backplane.Oauth.Ecto.Token` resource administration

- [Backplane.Oauth.Ecto.Client](Backplane.Oauth.Ecto.Client.md): Ecto Adapter Client Schema

- [Backplane.Oauth.Ecto.Scope](Backplane.Oauth.Ecto.Scope.md): Ecto Adapter Scope Schema

- [Backplane.Oauth.Ecto.Token](Backplane.Oauth.Ecto.Token.md): Ecto Adapter Token Schema

- [Backplane.Oauth.Error](Backplane.Oauth.Error.md): Backplane OAuth OAuth errors
- [Backplane.Oauth.HybridRequest](Backplane.Oauth.HybridRequest.md): Hybrid request

- [Backplane.Oauth.IdToken](Backplane.Oauth.IdToken.md): OpenID Connect id token schema and utilities

- [Backplane.Oauth.Introspect](Backplane.Oauth.Introspect.md): Access token introspection

- [Backplane.Oauth.IntrospectApplication](Backplane.Oauth.IntrospectApplication.md): OAuth application behaviour - introspect endpoint
- [Backplane.Oauth.IntrospectRequest](Backplane.Oauth.IntrospectRequest.md): Introspect request

- [Backplane.Oauth.IntrospectResponse](Backplane.Oauth.IntrospectResponse.md): Response returned in case of introspection request success. Provides mandatory data needed to respond to token introspection.

- [Backplane.Oauth.Openid](Backplane.Oauth.Openid.md): Openid requests entrypoint, provides additional artifacts to OAuth as stated in [Openid Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html).
- [Backplane.Oauth.Openid.Application](Backplane.Oauth.Openid.Application.md): Implement this behaviour in the application layer of your OpenID Connect provider.
This behaviour gives all callbacks triggered invoking `Backplane.Oauth.Openid` module functions.
- [Backplane.Oauth.Openid.DynamicRegistrationApplication](Backplane.Oauth.Openid.DynamicRegistrationApplication.md): Implement this behaviour in the application layer of your OpenID Connect provider.
This behaviour gives all callbacks triggered invoking `Backplane.Oauth.Openid.register_client/3` function.

- [Backplane.Oauth.Openid.JwksApplication](Backplane.Oauth.Openid.JwksApplication.md): Implement this behaviour in the application layer of your OpenID Connect provider.
This behaviour gives all callbacks triggered invoking `Backplane.Oauth.Openid.jwks/2` function.

- [Backplane.Oauth.Openid.UserinfoApplication](Backplane.Oauth.Openid.UserinfoApplication.md): Implement this behaviour in the application layer of your OpenID Connect provider.
This behaviour gives all callbacks triggered invoking `Backplane.Oauth.Openid.userinfo/2` function.

- [Backplane.Oauth.PasswordRequest](Backplane.Oauth.PasswordRequest.md): Resource owner password credentials request

- [Backplane.Oauth.RefreshTokenRequest](Backplane.Oauth.RefreshTokenRequest.md): Refresh token request

- [Backplane.Oauth.Request](Backplane.Oauth.Request.md): Build an oauth request struct from given input.
- [Backplane.Oauth.ResourceOwner](Backplane.Oauth.ResourceOwner.md): Oauth resource owner schema

- [Backplane.Oauth.ResourceOwners](Backplane.Oauth.ResourceOwners.md): Resource owner context

- [Backplane.Oauth.Revoke](Backplane.Oauth.Revoke.md): Access token revocation

- [Backplane.Oauth.RevokeApplication](Backplane.Oauth.RevokeApplication.md): OAuth application behaviour - revoke endpoint
- [Backplane.Oauth.RevokeRequest](Backplane.Oauth.RevokeRequest.md): Revoke request

- [Backplane.Oauth.Scope](Backplane.Oauth.Scope.md): OAuth scope schema and utilities

- [Backplane.Oauth.Scopes](Backplane.Oauth.Scopes.md): Scope context

- [Backplane.Oauth.ScopesAdapter](Backplane.Oauth.ScopesAdapter.md): Encapsulate injected `Backplane.Oauth.Scopes` adapter in context configuration

- [Backplane.Oauth.Token](Backplane.Oauth.Token.md): OAuth access token and code schema and utilities

- [Backplane.Oauth.TokenApplication](Backplane.Oauth.TokenApplication.md): OAuth application behaviour - token endpoint
- [Backplane.Oauth.TokenGenerator](Backplane.Oauth.TokenGenerator.md): Behaviour to implement utilities to generate token value. This must be implemented in the module configured as `token_generator` set in `config.exs`

- [Backplane.Oauth.TokenRequest](Backplane.Oauth.TokenRequest.md): Implicit request

- [Backplane.Oauth.TokenResponse](Backplane.Oauth.TokenResponse.md): Response returned in case of access token request success. Provides utilities and mandatory data needed to respond to the token part of client credentials, resource owner password, code and hybrid flows.

- [Backplane.Oauth.Validator](Backplane.Oauth.Validator.md): Utility to validate the request according to the given parameters

## Mix Tasks

- [mix backplane_oauth.gen.controllers](Mix.Tasks.BackplaneOauth.Gen.Controllers.md): This task will help creation of a basic OAuth/OpenID Connect server by providing needed phoenix controllers, views and templates to expose OAuth endpoints.
- [mix backplane_oauth.gen.migration](Mix.Tasks.BackplaneOauth.Gen.Migration.md): Migration task for Backplane OAuth.