sasjs/adapter
1
0
Fork 0
mirror of https://github.com/sasjs/adapter.git synced 2026-01-17 09:00:06 +00:00
Code Issues Projects Releases Wiki Activity

docs(refreshTokensForViya): added notes about limitation

Browse Source
This commit is contained in:
Yury Shkoda
2023-04-21 11:06:48 +03:00
parent 8360519408
commit a29b7f3b92
3 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/SASViyaApiClient.ts
View File

@@ -548,6 +548,7 @@ export class SASViyaApiClient {
/** /**
* Exchanges the refresh token for an access token for the given client. * Exchanges the refresh token for an access token for the given client.
* This method can only be used by Node.
* @param clientId - the client ID to authenticate with. * @param clientId - the client ID to authenticate with.
* @param clientSecret - the client secret to authenticate with. * @param clientSecret - the client secret to authenticate with.
* @param refreshToken - the refresh token received from the server. * @param refreshToken - the refresh token received from the server.

1
src/auth/getTokens.ts
View File

@@ -10,6 +10,7 @@ import { refreshTokensForSasjs } from './refreshTokensForSasjs'
/** /**
* Returns the auth configuration, refreshing the tokens if necessary. * Returns the auth configuration, refreshing the tokens if necessary.
* This function can only be used by Node, if a server type is SASVIYA.
* @param requestClient - the pre-configured HTTP request client * @param requestClient - the pre-configured HTTP request client
* @param authConfig - an object containing a client ID, secret, access token and refresh token * @param authConfig - an object containing a client ID, secret, access token and refresh token
* @param serverType - server type for which refreshing the tokens, defaults to SASVIYA * @param serverType - server type for which refreshing the tokens, defaults to SASVIYA

1
src/auth/refreshTokensForViya.ts
View File

@@ -6,6 +6,7 @@ import { isNode } from '../utils'
/** /**
* Exchanges the refresh token for an access token for the given client. * Exchanges the refresh token for an access token for the given client.
* This function can only be used by Node.
* @param requestClient - the pre-configured HTTP request client * @param requestClient - the pre-configured HTTP request client
* @param clientId - the client ID to authenticate with. * @param clientId - the client ID to authenticate with.
* @param clientSecret - the client secret to authenticate with. * @param clientSecret - the client secret to authenticate with.