View Source Dnsimple.Oauth (dnsimple v4.0.0)

Provides functions to authenticate through the OAuth web application flow.

See:

Summary

Functions

authorize_url(client, client_id, query \\ [])

Returns the URL to start the OAuth dance.

exchange_authorization_for_token(client, attributes, options \\ [])

Returns the access token for a given authorization code.

Functions

authorize_url(client, client_id, query \\ [])

@spec authorize_url(Dnsimple.Client.t(), String.t(), Keyword.t()) :: String.t()

Returns the URL to start the OAuth dance.

See:

https://developer.dnsimple.com/v2/oauth/#step-1---authorization

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
url = Dnsimple.Oauth.authorize_url(client, client_id = "1z2y3x", state: "12345678")

exchange_authorization_for_token(client, attributes, options \\ [])

@spec exchange_authorization_for_token(Dnsimple.Client.t(), map(), keyword()) ::
  {:ok | :error, String.t()}

Returns the access token for a given authorization code.

See:

https://developer.dnsimple.com/v2/oauth/#step-2---access-token

Examples:

client = %Dnsimple.Client{access_token: "a1b2c3d4"}
{:ok, response} = Dnsimple.Oauth.exchange_authorization_for_token(client, %{
  code: "authorization_code",
  state: "12345678",
  client_id: "1z2y3x",
  client_secret: "xXxXxX",
})