Boruta.Oauth.Clients behaviour (Boruta core v3.0.0-beta.4)

View Source

Client context

Summary

Callbacks

Returns client authorized scopes. The scopes will be granted for every requests to the given client.

Returns a Boruta.Oauth.Client given id.

Returns all clients jwk public keys

Returns the public Boruta.Oauth.Client.

Callbacks

authorized_scopes(client)

@callback authorized_scopes(client :: Boruta.Oauth.Client.t()) :: [Boruta.Oauth.Scope.t()]

Returns client authorized scopes. The scopes will be granted for every requests to the given client.

get_client(id)

@callback get_client(id :: any()) :: client :: Boruta.Oauth.Client.t() | nil

Returns a Boruta.Oauth.Client given id.

get_client_by_did(did)

@callback get_client_by_did(did :: String.t()) :: client :: Boruta.Oauth.Client.t() | nil

Returns a Boruta.Oauth.Client given did.

list_clients_jwk()

(optional)
@callback list_clients_jwk() :: [%JOSE.JWK{fields: term(), keys: term(), kty: term()}]

Returns all clients jwk public keys

public!()

@callback public!() :: client :: Boruta.Oauth.Client.t() | nil

Returns the public Boruta.Oauth.Client.