Class AuthenticationClient

Client providing access to Autodesk Forge Authentication APIs.

link: https://forge.autodesk.com/en/docs/oauth/v2

Hierarchy

AuthenticationClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AuthenticationClient(clientId: string, clientSecret: string, host?: string): AuthenticationClient

- Defined in auth.ts:31
Parameters
- clientId: string
- clientSecret: string
- Optional host: string
Returns AuthenticationClient

Properties

Protected authProvider

authProvider: IAuthProvider

Protected clientId

clientId: string

Protected clientSecret

clientSecret: string

Protected host

host: string

Protected userProfileApi

userProfileApi: UserProfileApi

Methods

authenticate

authenticate(scopes: Scope[], force?: boolean): Promise<AuthToken>

- Defined in auth.ts:50
Retrieves 2-legged access token for a specific set of scopes. Unless the {@see force} parameter is used, the access tokens are cached based on their scopes and the expires_in field in the response.

link

https://forge.autodesk.com/en/docs/oauth/v2/reference/http/authenticate-POST

link

https://forge.autodesk.com/en/docs/oauth/v2/developers_guide/scopes

async

Parameters
- scopes: Scope[]
  
  List of requested scopes.
- Optional force: boolean
Returns Promise<AuthToken>

2-legged access token object.

getAuthorizationUrl

getAuthorizationUrl(scopes: Scope[], redirectUri: string): string

- Defined in auth.ts:62
Generates a URL that users should be redirected to in 3-legged OAuth workflows.

link

https://forge.autodesk.com/en/docs/oauth/v2/reference/http/authorize-GET

link

https://forge.autodesk.com/en/docs/oauth/v2/developers_guide/scopes

Parameters
- scopes: Scope[]
  
  List of requested scopes.
- redirectUri: string
  
  Callback URL. Must match the URL configured for this app on the Forge portal.
Returns string

Autodesk login URL.

getToken

getToken(code: string, redirectUri: string): Promise<AuthToken>

- Defined in auth.ts:74
Exchanges temporary code retrieved from 3-legged OAuth workflow for an access token.

link

https://forge.autodesk.com/en/docs/oauth/v2/reference/http/gettoken-POST

async

Parameters
- code: string
  
  Temporary code returned from the 3-legged OAuth workflow.
- redirectUri: string
  
  Callback URL. Must match the URL configured for this app on the Forge portal.
Returns Promise<AuthToken>

3-legged access token object.

getUserProfile

getUserProfile(token: AuthToken): Promise<IUserProfile>

- Defined in auth.ts:102
Gets profile information for a user based on their 3-legged auth token.

link

https://forge.autodesk.com/en/docs/oauth/v2/reference/http/users-@me-GET

async

Parameters
- token: AuthToken
  
  3-legged authentication token.
Returns Promise<IUserProfile>

User profile information.

refreshToken

refreshToken(refreshToken: string, scopes: Scope[]): Promise<AuthToken>

- Defined in auth.ts:89
Refreshes 3-legged access token.

link

https://forge.autodesk.com/en/docs/oauth/v2/reference/http/refreshtoken-POST

link

https://forge.autodesk.com/en/docs/oauth/v2/developers_guide/scopes

async

Parameters
- refreshToken: string
  
  Refresh token.
- scopes: Scope[]
  
  List of requested scopes.
Returns Promise<AuthToken>

3-legged access token object.

Generated using TypeDoc