API Reference Boruta core v2.0.0-rc.1
Modules
Boruta is the core of an OAuth provider giving business logic of authentication and authorization.
Encapsulate injected access_tokens adapter in context configuration.
HTTP BasicAuth utilities
Boruta Ecto adapter uses Nebulex in order to cache entities
This is the cache for the primary storage.
Encapsulate injected clients adapter in context configuration.
Encapsulate injected codes adapter in context configuration.
Utilities to access Boruta configuration ad set defaults.
Administration of Boruta resources.
Boruta.Ecto.Client
resource administration.
Boruta.Ecto.Scope
resource administration.
Boruta.Ecto.Token
resource administration.
Ecto Adapter Client Schema
Ecto Adapter Scope Schema
Ecto Adapter Token Schema
Boruta OAuth entrypoint, handles OAuth requests.
Access token context
OAuth application behaviour
Access token authorization
Client authorization
Code authorization
OpenID Connect nonce authorization
Resource owner authorization
Scope authorization
Authorization code request
Struct encapsulating an authorization success
OAuth application behaviour - authorize endpoint
Authorize response
OAuth client schema
Client credentials request
Client context
Code request
Code context
Boruta OAuth errors
Hybrid request
OAuth Introspect
OAuth application behaviour - introspect endpoint
Introspect request
Introspect response
Resource owner password credentials request
Refresh token request
Build an oauth request struct from given input.
Oauth resource owner
Resource owner context
OAuth Revoke
OAuth application behaviour - revoke endpoint
Revoke request
Schema defining an independent OAuth scope
Scope context
Token schema. Representing both access tokens and codes.
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
Token response
Utility to validate the request according to the given parameters.
Encapsulate injected scopes adapter in context configuration.
Mix Tasks
This task will help creation of a basic OAuth server by providing needed phoenix controllers, views and templates helping OAuth endpoints exposition.
Migration task for Boruta.