HookSniffAPI.Api.OAuth (HookSniff v0.3.0)

API calls for all endpoints tagged OAuth.

Summary

Functions

oauth_google_callback_get(connection, opts \\ [])

Google OAuth callback

oauth_google_get(connection, opts \\ [])

Google OAuth login redirect

oauth_providers_get(connection, opts \\ [])

List available OAuth providers

Functions

oauth_google_callback_get(connection, opts \\ [])

@spec oauth_google_callback_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Google OAuth callback

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

oauth_google_get(connection, opts \\ [])

@spec oauth_google_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Google OAuth login redirect

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

oauth_providers_get(connection, opts \\ [])

@spec oauth_providers_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

List available OAuth providers

Parameters

connection (HookSniffAPI.Connection): Connection to server
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure