com.dnsimple

Interface Oauth

All Known Implementing Classes:

OauthEndpoint

public interface Oauth

Provides access to the DNSimple OAuth API.

See Also:

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

Method Summary

Modifier and Type	Method and Description
String	authorizeUrl(String clientId) Gets the URL to authorize a user for an application via the OAuth2 flow.
String	authorizeUrl(String clientId, Map<Object,Object> options) Gets the URL to authorize a user for an application via the OAuth2 flow.
OauthToken	exchangeAuthorizationForToken(String code, String clientId, String clientSecret) Exchange the short-lived authorization code for an access token that is used to authenticate API calls.
OauthToken	exchangeAuthorizationForToken(String code, String clientId, String clientSecret, Map<String,Object> options) Exchange the short-lived authorization code for an access token that is used to authenticate API calls.

Method Detail

exchangeAuthorizationForToken

OauthToken exchangeAuthorizationForToken(String code,
                                         String clientId,
                                         String clientSecret)
                                  throws DnsimpleException,
                                         IOException

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

Parameters:

code - The authorization code

clientId - The client ID

clientSecret - The client secret

Returns:

The OauthToken instance

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

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

exchangeAuthorizationForToken

OauthToken exchangeAuthorizationForToken(String code,
                                         String clientId,
                                         String clientSecret,
                                         Map<String,Object> options)
                                  throws DnsimpleException,
                                         IOException

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

Parameters:

code - The authorization code

clientId - The client ID

clientSecret - The client secret

options - Map of options

Returns:

The OauthToken instance

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

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

authorizeUrl

String authorizeUrl(String clientId)

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

Parameters:

clientId - The client ID of the OAuth app in DNSimple

Returns:

The authorize URL String

See Also:

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

authorizeUrl

String authorizeUrl(String clientId,
                    Map<Object,Object> options)

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

Parameters:

clientId - The client ID of the OAuth app in DNSimple

options - A Map of options to include as parameters in the generated URL

Returns:

The authorize URL string

See Also:

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