UrlForAuthenticationConfig

public final class UrlForAuthenticationConfig

Configuration for generating a URL for OAuth 2.0 authentication.

Constructors

Link copied to clipboard
public UrlForAuthenticationConfig UrlForAuthenticationConfig(@Json(name = "client_id") String clientId, @Json(name = "redirect_uri") String redirectUri, @Json(name = "access_type") AccessType accessType, @Json(name = "provider") AuthProvider provider, @Json(name = "prompt") String prompt, @Json(name = "scope") List<String> scope, @Json(name = "include_grant_scopes") Boolean includeGrantScopes, @Json(name = "state") String state, @Json(name = "login_hint") String loginHint)

Types

Link copied to clipboard
public final class Builder

Properties

Link copied to clipboard
private final AccessType accessType

If the exchange token should return a refresh token too. Not suitable for client side or JavaScript apps.

Link copied to clipboard
private final String clientId

The client ID of your application.

Link copied to clipboard

If set to true, the scopes granted to the application will be included in the response.

Link copied to clipboard
private final String loginHint

Prefill the login name (usually email) during authorization flow. If a Grant for the provided email already exists, a Grant's re-auth will automatically be initiated.

Link copied to clipboard
private final String prompt

The prompt parameter is used to force the consent screen to be displayed even if the user has already given consent to your application.

Link copied to clipboard
private final AuthProvider provider

The integration provider type that you already had set up with Nylas for this application. If not set, the user is directed to the Hosted Login screen and prompted to select a provider.

Link copied to clipboard
private final String redirectUri

Redirect URI of the integration.

Link copied to clipboard
private final List<String> scope

A space-delimited list of scopes that identify the resources that your application could access on the user's behalf. If no scope is given, all of the default integration's scopes are used.

Link copied to clipboard
private final String state

Optional state to be returned after authentication

Functions

Link copied to clipboard
public final AccessType getAccessType()

If the exchange token should return a refresh token too. Not suitable for client side or JavaScript apps.

Link copied to clipboard
public final String getClientId()

The client ID of your application.

Link copied to clipboard

If set to true, the scopes granted to the application will be included in the response.

Link copied to clipboard
public final String getLoginHint()

Prefill the login name (usually email) during authorization flow. If a Grant for the provided email already exists, a Grant's re-auth will automatically be initiated.

Link copied to clipboard
public final String getPrompt()

The prompt parameter is used to force the consent screen to be displayed even if the user has already given consent to your application.

Link copied to clipboard
public final AuthProvider getProvider()

The integration provider type that you already had set up with Nylas for this application. If not set, the user is directed to the Hosted Login screen and prompted to select a provider.

Link copied to clipboard
public final String getRedirectUri()

Redirect URI of the integration.

Link copied to clipboard
public final List<String> getScope()

A space-delimited list of scopes that identify the resources that your application could access on the user's behalf. If no scope is given, all of the default integration's scopes are used.

Link copied to clipboard
public final String getState()

Optional state to be returned after authentication