Auth

public final class Auth

A collection of authentication related API endpoints

These endpoints allow for various functionality related to authentication. Also contains the Grants API and collection of provider API endpoints.

Parameters

client

The configured Nylas API client

Constructors

Auth

public Auth Auth(NylasClient client)

Functions

accessTokenInfo

@JvmOverloads()

public final Response<TokenInfoResponse> accessTokenInfo(String accessToken)

@JvmOverloads()

public final Response<TokenInfoResponse> accessTokenInfo(String accessToken, RequestOverrides overrides)

Get info about an access token

customAuthentication

@JvmOverloads()

public final Response<Grant> customAuthentication(CreateGrantRequest requestBody)

@JvmOverloads()

public final Response<Grant> customAuthentication(CreateGrantRequest requestBody, RequestOverrides overrides)

Create a grant via custom authentication

detectProvider

@JvmOverloads()

public final Response<ProviderDetectResponse> detectProvider(ProviderDetectParams params)

@JvmOverloads()

public final Response<ProviderDetectResponse> detectProvider(ProviderDetectParams params, RequestOverrides overrides)

Detect provider from email address

exchangeCodeForToken

@JvmOverloads()

public final CodeExchangeResponse exchangeCodeForToken(CodeExchangeRequest request)

@JvmOverloads()

public final CodeExchangeResponse exchangeCodeForToken(CodeExchangeRequest request, RequestOverrides overrides)

Exchange an authorization code for an access token

idTokenInfo

@JvmOverloads()

public final Response<TokenInfoResponse> idTokenInfo(String idToken)

@JvmOverloads()

public final Response<TokenInfoResponse> idTokenInfo(String idToken, RequestOverrides overrides)

Get info about an ID token

refreshAccessToken

@JvmOverloads()

public final CodeExchangeResponse refreshAccessToken(TokenExchangeRequest request)

@JvmOverloads()

public final CodeExchangeResponse refreshAccessToken(TokenExchangeRequest request, RequestOverrides overrides)

Refresh an access token

revoke

@JvmOverloads()

public final Boolean revoke(TokenParams token)

@JvmOverloads()

public final Boolean revoke(TokenParams token, RequestOverrides overrides)

Revoke a token (and the grant attached to the token)

urlForAdminConsent

public final String urlForAdminConsent(UrlForAuthenticationConfig config, String credentialId)

Build the URL for admin consent authentication for Microsoft

urlForOAuth2

public final String urlForOAuth2(UrlForAuthenticationConfig config)

Build the URL for authenticating users to your application with OAuth 2.0

urlForOAuth2PKCE

public final PKCEAuthURL urlForOAuth2PKCE(UrlForAuthenticationConfig config)

Build the URL for authenticating users to your application with OAuth 2.0 and PKCE