Class TokenManager

The token manager for the BYoDS SDK.

Hierarchy

TokenManager

Index

Constructors

Methods

updateServiceAppToken getServiceAppId getOrgServiceAppAuthorization listTokens deleteToken resetTokens getServiceAppTokenUsingPAT refreshServiceAppAccessToken saveServiceAppRegistrationData

Constructors

constructor

new TokenManager(clientId: string, clientSecret: string, baseUrl?: string, tokenStorageAdapter?: TokenStorageAdapter, loggerConfig?: LoggerConfig): TokenManager
Creates an instance of TokenManager.

Example
```
const tokenManager = new TokenManager('your-client-id', 'your-client-secret');
```
Parameters
- clientId: string
  
  The client ID of the service app.
- clientSecret: string
  
  The client secret of the service app.
- baseUrl: string = PRODUCTION_BASE_URL
  
  The base URL for the API. Defaults to PRODUCTION_BASE_URL.
- tokenStorageAdapter: TokenStorageAdapter = ...
- loggerConfig: LoggerConfig = DEFAULT_LOGGER_CONFIG
Returns TokenManager

Methods

updateServiceAppToken

updateServiceAppToken(data: TokenResponse, orgId: string): Promise<void>
Update the tokens and their expiration times.

Returns

Example
```
await tokenManager.updateServiceAppToken(tokenResponse, 'org-id');
```
Parameters
- data: TokenResponse
  
  The token response data.
- orgId: string
  
  The organization ID.
Returns Promise<void>

getServiceAppId

getServiceAppId(): string

Get the service app ID.

Returns

Example

const serviceAppId = tokenManager.getServiceAppId();

Returns string

getOrgServiceAppAuthorization

getOrgServiceAppAuthorization(orgId: string): Promise<OrgServiceAppAuthorization>
Get the service app authorization data for a given organization ID.

Returns

Example
```
const authorization = await tokenManager.getOrgServiceAppAuthorization('org-id');
```
Parameters
- orgId: string
  
  The organization ID.
Returns Promise<OrgServiceAppAuthorization>

listTokens

listTokens(): Promise<OrgServiceAppAuthorization[]>
List all stored tokens.

Returns
List of tokens

Example
```
const tokens = await tokenManager.listTokens();
```
Returns Promise<OrgServiceAppAuthorization[]>

deleteToken

deleteToken(orgId: string): Promise<void>
Delete a token for a given orgId.

Returns

Example
```
await tokenManager.deleteToken('org-id');
```
Parameters
- orgId: string
  
  The organization ID.
Returns Promise<void>

resetTokens

resetTokens(): Promise<void>
Remove all tokens stored in the TokenStorageAdapter.

Returns

Example
```
await tokenManager.resetTokens();
```
Returns Promise<void>

getServiceAppTokenUsingPAT

getServiceAppTokenUsingPAT(orgId: string, personalAccessToken: string, headers?: Record<string, string>): Promise<void>
Retrieve a new service app token using the service app owner's personal access token(PAT).

Returns
await tokenManager.getServiceAppTokenUsingPAT('org-id', 'personal-access-token');
Parameters
- orgId: string
  
  The organization ID.
- personalAccessToken: string
  
  The service app owner's personal access token or token from an integration that has the scope spark:applications_token.
- headers: Record<string, string> = {}
Returns Promise<void>

refreshServiceAppAccessToken

refreshServiceAppAccessToken(orgId: string, headers?: Record<string, string>): Promise<void>
Refresh the access token using the refresh token.

Returns
await tokenManager.refreshServiceAppAccessToken('org-id');
Parameters
- orgId: string
  
  The organization ID.
- headers: Record<string, string> = {}
Returns Promise<void>

saveServiceAppRegistrationData

saveServiceAppRegistrationData(orgId: string, refreshToken: string, headers?: Record<string, string>): Promise<void>
Save the service app registration using the provided refresh token. After saving, it can be fetched by using the getOrgServiceAppAuthorization method.

Returns

Example
```
await tokenManager.saveServiceAppRegistrationData('org-id', 'refresh-token');
```
Parameters
- orgId: string
  
  The organization ID.
- refreshToken: string
  
  The refresh token.
- headers: Record<string, string> = {}
Returns Promise<void>

Class TokenManager

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Example

Parameters

clientId: string

clientSecret: string

baseUrl: string = PRODUCTION_BASE_URL

tokenStorageAdapter: TokenStorageAdapter = ...

loggerConfig: LoggerConfig = DEFAULT_LOGGER_CONFIG

Returns TokenManager

Methods

updateServiceAppToken

Returns

Example

Parameters

data: TokenResponse

orgId: string

Returns Promise<void>

getServiceAppId

Returns

Example

Returns string

getOrgServiceAppAuthorization

Returns

Example

Parameters

orgId: string

Returns Promise<OrgServiceAppAuthorization>

listTokens

Returns

Example

Returns Promise<OrgServiceAppAuthorization[]>

deleteToken

Returns

Example

Parameters

orgId: string

Returns Promise<void>

resetTokens

Returns

Example

Returns Promise<void>

getServiceAppTokenUsingPAT

Returns

Parameters

orgId: string

personalAccessToken: string

headers: Record<string, string> = {}

Returns Promise<void>

refreshServiceAppAccessToken

Returns

Parameters

orgId: string

headers: Record<string, string> = {}

Returns Promise<void>

saveServiceAppRegistrationData

Returns

Example

Parameters

orgId: string

refreshToken: string

headers: Record<string, string> = {}

Returns Promise<void>

Settings

Member Visibility

Theme