API Reference backplane_oauth v#1.10.77

Copy Markdown View Source

Modules

OAuth requests entrypoint, provides authorization artifacts to clients as stated in RFC.

Access token context

Encapsulate injected Backplane.Oauth.AccessTokens adapter in context configuration

Implement this behaviour in the application layer of your OAuth / OpenID Connect provider. This behaviour gives all callbacks triggered invoking Backplane.Oauth module functions.

OAuth requests authorization

Check against given params and return the corresponding access token

Check against given params and return the corresponding client

Check against given params and return the corresponding code

Check OpenID Connect nonce against given request

Check against given params and return the corresponding resource owner

Check against given params and return the corresponding scopes

Authorization code request

Struct encapsulating an authorization success data

OAuth application behaviour - authorize endpoint

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.

HTTP BasicAuth utilities

OAuth bearer token utilities

Backplane OAuth Ecto adapter uses Nebulex in order to cache entities

This is the cache for the primary storage.

OAuth client schema and utilities

Client credentials request

Client context

Encapsulate injected Backplane.Oauth.Clients adapter in context configuration

Code context

Encapsulate injected Backplane.Oauth.Codes adapter in context configuration

Utilities to access Backplane OAuth configuration ad set defaults.

Administration of Backplane OAuth resources.

Ecto Adapter Client Schema

Ecto Adapter Scope Schema

Ecto Adapter Token Schema

Backplane OAuth OAuth errors

OpenID Connect id token schema and utilities

Access token introspection

OAuth application behaviour - introspect endpoint

Response returned in case of introspection request success. Provides mandatory data needed to respond to token introspection.

Openid requests entrypoint, provides additional artifacts to OAuth as stated in Openid Connect Core 1.0.

Implement this behaviour in the application layer of your OpenID Connect provider. This behaviour gives all callbacks triggered invoking Backplane.Oauth.Openid module functions.

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.

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.

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.

Resource owner password credentials request

Refresh token request

Build an oauth request struct from given input.

Oauth resource owner schema

Resource owner context

Access token revocation

OAuth application behaviour - revoke endpoint

OAuth scope schema and utilities

Scope context

Encapsulate injected Backplane.Oauth.Scopes adapter in context configuration

OAuth access token and code schema and utilities

OAuth application behaviour - token endpoint

Behaviour to implement utilities to generate token value. This must be implemented in the module configured as token_generator set in config.exs

Implicit request

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.

Utility to validate the request according to the given parameters

Mix Tasks

This task will help creation of a basic OAuth/OpenID Connect server by providing needed phoenix controllers, views and templates to expose OAuth endpoints.

Migration task for Backplane OAuth.