Package com.dnsimple.endpoints

Class Oauth

java.lang.Object

com.dnsimple.endpoints.Oauth

public class Oauth
extends Object

Provides access to the DNSimple OAuth API.

See Also:

• https://developer.dnsimple.com/v2/oauth

Constructor Summary

Constructors

Constructor	Description
Oauth(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
String	authorizeUrl(OauthAuthorizeOptions options)	Gets the URL to authorize a user for an application via the OAuth2 flow.
AccessToken	exchangeAuthorizationForToken(OauthExchangeOptions options)	Exchange the short-lived authorization code for an access token that is used to authenticate API calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Oauth

public Oauth(HttpEndpointClient client)

Method Details

authorizeUrl

public String authorizeUrl(OauthAuthorizeOptions options)

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

Parameters:

options - The options for the OAuth authorization URL

Returns:

The authorize URL String

See Also:

• https://developer.dnsimple.com/v2/oauth/

exchangeAuthorizationForToken

public AccessToken exchangeAuthorizationForToken(OauthExchangeOptions options)

Exchange the short-lived authorization code for an access token that is used to authenticate API calls.

Parameters:

options - The options for the OAuth exchange call

Returns:

The AccessToken instance

See Also:

• https://developer.dnsimple.com/v2/oauth