Method: Dnsimple::Client::Oauth#authorize_url

Defined in:
lib/dnsimple/client/oauth.rb

#authorize_url(client_id, options = {}) ⇒ String

Gets the URL to authorize an user for an application via the OAuth2 flow.

Parameters:

  • client_id (String) —

    Client Id you received when the application was registered with DNSimple.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :redirect_uri (String) —

    The URL to redirect to after authorizing.

  • :scope (String) —

    The scopes to request from the user.

  • :state (String) —

    A random string to protect against CSRF.

Returns:

  • (String) —

    The URL to redirect the user to authorize.

See Also:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/dnsimple/client/oauth.rb', line 31

def authorize_url(client_id, options = {})
  site_url = client.base_url.sub("api.", "")
  url = URI.join(site_url, "/oauth/authorize?client_id=#{client_id}")

  options = options.merge(response_type: "code")
  options.each do |key, value|
    url.query += "&#{key}=#{value}"
  end
  url.to_s
end