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.

Constructors

constructor

new Auth(apiClient: APIClient): Auth
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Auth
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:170

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:184

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:144

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:199

`Protected`_getStream

_getStream(__namedParameters: FindParams<void>): Promise<ReadableStream>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:212

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:124

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:174

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:178

accessTokenInfo

accessTokenInfo(accessToken: string): Promise<NylasResponse<TokenInfoResponse>>
Get info about an access token
Parameters
- accessToken: string
  The access token to query.
Returns Promise<NylasResponse<TokenInfoResponse>>
The token information
- Defined in src/resources/auth.ts:182

customAuthentication

customAuthentication(
__namedParameters: CreateGrantParams & Overrides,
): Promise<NylasResponse<Grant>>
Create a grant via Custom Authentication
Parameters
- __namedParameters: CreateGrantParams & Overrides
Returns Promise<NylasResponse<Grant>>
The created grant
- Defined in src/resources/auth.ts:122

detectProvider

detectProvider(
params: ProviderDetectParams,
): Promise<NylasResponse<ProviderDetectResponse>>
Detect provider from email address
Parameters
- params: ProviderDetectParams
  The parameters to include in the request
Returns Promise<NylasResponse<ProviderDetectResponse>>
The detected provider, if found
- Defined in src/resources/auth.ts:156

exchangeCodeForToken

exchangeCodeForToken(
request: CodeExchangeRequest,
): Promise<CodeExchangeResponse>
Exchange an authorization code for an access token
Parameters
- request: CodeExchangeRequest
  The request parameters for the code exchange
Returns Promise<CodeExchangeResponse>
Information about the Nylas application
- Defined in src/resources/auth.ts:48

idTokenInfo

idTokenInfo(idToken: string): Promise<NylasResponse<TokenInfoResponse>>
Get info about an ID token
Parameters
- idToken: string
  The ID token to query.
Returns Promise<NylasResponse<TokenInfoResponse>>
The token information
- Defined in src/resources/auth.ts:171

refreshAccessToken

refreshAccessToken(request: TokenExchangeRequest): Promise<CodeExchangeResponse>
Refresh an access token
Parameters
- request: TokenExchangeRequest
  The refresh token request
Returns Promise<CodeExchangeResponse>
The response containing the new access token
- Defined in src/resources/auth.ts:70

revoke

revoke(token: string): Promise<boolean>
Revoke a token (and the grant attached to the token)
Parameters
- token: string
  The token to revoke
Returns Promise<boolean>
True if the token was revoked successfully
- Defined in src/resources/auth.ts:139

urlForAdminConsent

urlForAdminConsent(config: URLForAdminConsentConfig): string
Build the URL for admin consent authentication for Microsoft
Parameters
- config: URLForAdminConsentConfig
  The configuration for building the URL
Returns string
The URL for admin consent authentication
- Defined in src/resources/auth.ts:110

urlForOAuth2

urlForOAuth2(config: URLForAuthenticationConfig): string
Build the URL for authenticating users to your application with OAuth 2.0
Parameters
- config: URLForAuthenticationConfig
  The configuration for building the URL
Returns string
The URL for hosted authentication
- Defined in src/resources/auth.ts:39

urlForOAuth2PKCE

urlForOAuth2PKCE(config: URLForAuthenticationConfig): PKCEAuthURL
Build the URL for authenticating users to your application with OAuth 2.0 and PKCE IMPORTANT: YOU WILL NEED TO STORE THE 'secret' returned to use it inside the CodeExchange flow
Parameters
- config: URLForAuthenticationConfig
  The configuration for building the URL
Returns PKCEAuthURL
The URL for hosted authentication
- Defined in src/resources/auth.ts:93