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.

Hierarchy

Resource
- Auth

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch customAuthentication detectProvider exchangeCodeForToken refreshAccessToken revoke urlForAdminConsent urlForOAuth2 urlForOAuth2PKCE

Constructors

constructor

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

Properties

`Protected` apiClient

apiClient: default

Methods

`Protected` _create

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

`Protected` _destroy

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

`Protected` _find

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

`Protected` _getRaw

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

`Protected` _getStream

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

`Protected` _list

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

`Protected` _update

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

`Protected` _updatePatch

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

customAuthentication

customAuthentication(__namedParameters): 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:120

detectProvider

detectProvider(params): 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:154

exchangeCodeForToken

exchangeCodeForToken(request): 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:46

refreshAccessToken

refreshAccessToken(request): 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:68

revoke

revoke(token): 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:137

urlForAdminConsent

urlForAdminConsent(config): 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:108

urlForOAuth2

urlForOAuth2(config): 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:37

urlForOAuth2PKCE

urlForOAuth2PKCE(config): 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:91

Generated using TypeDoc