@interopio/desktop API Reference

Authentication can use one of the following flows:

  • username/password;
  • token - access tokens can be generated after successful login from the Auth Provider (e.g., Auth0);
  • gatewayToken - Gateway tokens are time limited tokens generated by the Gateway after an explicit request. To generate one, use the io.connection.authToken() method;
  • sspi - using sessionId and authentication challenge callback;

Properties (9)

Property Type Default Required Description
flowCallback⚓︎ (sessionId: string, token: any) => Promise<{ data: any }> x x x
flowName⚓︎ "sspi" x x x
gatewayToken⚓︎ string x x

Authenticate using gatewayToken
password⚓︎ string x x

Password to be used
provider⚓︎ string x x

GW auth provider to be used
providerContext⚓︎ any x x

A context object, which will be passed along to the GW auth provider to be used to request verification
sessionId⚓︎ string x x x
token⚓︎ string x x

Authenticate using token generated from the auth provider.
username⚓︎ string x x

Username to be used