Interface TokenStorageAdapter

Represents a adapter for storing and retrieving service app authorization tokens.

Hierarchy

TokenStorageAdapter

Implemented by

InMemoryTokenStorageAdapter

Index

Methods

setToken getToken listTokens deleteToken resetTokens

Methods

setToken

setToken(orgId: string, token: OrgServiceAppAuthorization): Promise<void>
Method to set the token for an organization.

Example
```
await storageAdapter.setToken('org-id', token);
```
Parameters
- orgId: string
  
  Organization ID
- token: OrgServiceAppAuthorization
  
  Respective token
Returns Promise<void>

getToken

getToken(orgId: string): Promise<OrgServiceAppAuthorization>
Method to extract a token id based on the organization id.

Returns
The token object for the organization

Example
```
const token = await storageAdapter.getToken('org-id');
```
Parameters
- orgId: string
  
  Organization
Returns Promise<OrgServiceAppAuthorization>

listTokens

listTokens(): Promise<OrgServiceAppAuthorization[]>
Method which returns the list of all tokens stored in the TokenStorageAdapter.

Returns
List of tokens

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

deleteToken

deleteToken(orgId: string): Promise<void>
Method to delete a token based on the organization id.

Returns

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

resetTokens

resetTokens(): Promise<void>
Method to remove all tokens stored in the TokenStorageAdapter.

Returns

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