Interface: InitConfigParams
Configuration parameters for the SDK
Properties
clientId
• clientId: string
Your Transmit client identifier
drs
• drs: Object
Initial configuration for Detection and Response services (drs module)
Type declaration
| Name | Type | Description |
|---|---|---|
serverPath? |
string |
Server URL for Detection and Response services. Default value is https://api.transmitsecurity.io/risk-collect |
userId? |
string |
Opaque identifier of the user in your system, which should only be passed for users that have already been fully authenticated |
verbose? |
boolean |
Print logs to console |
enabled? |
boolean |
Used to disable data collection, which will effectively disable the Detection and Response capabilities. Default value is true |
enableSessionToken? |
boolean |
Used to enable session token that can be used to trigger action events via a backend API. Default value is false |
webauthn
Initial configuration for WebAuthn services (webauthn module)
• webauthn: Object
Type declaration
| Name | Type | Description |
|---|---|---|
serverPath |
string |
Base path for sending API requests. This would be either a Transmit Security API deployment URL such as documented for sandbox, or if you are proxying API requests from your backend - then the base path to your proxy. |
webauthnApiPaths? |
WebauthnApis |
Override endpoints when using a proxy server in case the proxy server implements its own paths. |