adk_oauth_adapter behaviour (erlang_adk v0.7.0)

Adapter behaviour for outbound OAuth token endpoint operations.

Summary

Types

opts/0

provider/0

token/0

Callbacks

client_credentials/4

refresh_token/6

Types

opts/0

-type opts() :: #{scope := [binary()], resource => binary()}.

provider/0

-type provider() :: gen_server:server_ref().

token/0

-type token() ::
          #{access_token := binary(),
            expires_in_ms := pos_integer(),
            token_type => binary(),
            refresh_token => binary()}.

Callbacks

client_credentials/4

-callback client_credentials(Provider :: provider(),
                             ClientId :: binary(),
                             ClientSecret :: binary(),
                             Opts :: opts()) ->
                                {ok, token()} | {error, term()}.

refresh_token/6

-callback refresh_token(Provider :: provider(),
                        ClientId :: binary(),
                        ClientSecret :: binary(),
                        RefreshToken :: binary(),
                        ExpectedSubject :: binary(),
                        Opts :: opts()) ->
                           {ok, token()} | {error, term()}.