nylas/com.nylas.models/UrlForAuthenticationConfig

UrlForAuthenticationConfig

public final class UrlForAuthenticationConfig

Configuration for generating a URL for OAuth 2.0 authentication.

Constructors

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") Prompt 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

Builder

public final class Builder

Builder for UrlForAuthenticationConfig.

Properties

accessType

private final AccessType accessType

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

clientId

private final String clientId

The client ID of your application.

includeGrantScopes

private final Boolean includeGrantScopes

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

loginHint

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.

prompt

private final Prompt 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.

provider

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.

redirectUri

private final String redirectUri

Redirect URI of the integration.

scope

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.

state

private final String state

Optional state to be returned after authentication

Functions

getAccessType

public final AccessType getAccessType()

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

getClientId

public final String getClientId()

The client ID of your application.

getIncludeGrantScopes

public final Boolean getIncludeGrantScopes()

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

getLoginHint

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.

getPrompt

public final Prompt 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.

getProvider

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.

getRedirectUri

public final String getRedirectUri()

Redirect URI of the integration.

getScope

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.

getState

public final String getState()

Optional state to be returned after authentication