CognitiveX Docs
SDK

oauthStart

Function from @cognitivx/api-client

oauthStart

Kind: Function Source: packages/api-client/src/endpoints/auth.ts:29 Generated from the TypeScript source for @cognitivx/api-client.

Signature

oauthStart(provider, returnTo)

Parameters

[
  {
    "name": "provider",
    "type": {
      "type": "union",
      "types": [
        {
          "type": "literal",
          "value": "google"
        },
        {
          "type": "literal",
          "value": "github"
        },
        {
          "type": "literal",
          "value": "twitter"
        }
      ]
    },
    "summary": ""
  },
  {
    "name": "returnTo",
    "type": {
      "type": "intrinsic",
      "name": "string"
    },
    "summary": ""
  }
]

TypeDoc reflection

{
  "name": "oauthStart",
  "kind": "Function",
  "source": "packages/api-client/src/endpoints/auth.ts:29"
}