vaultsessionscreaterequest.md

VaultSessionsCreateRequest

Example Usage

import { VaultSessionsCreateRequest } from "@apideck/unify/models/operations";

let value: VaultSessionsCreateRequest = {
  session: {
    consumerMetadata: {
      accountName: "SpaceX",
      userName: "Elon Musk",
      email: "[email protected]",
      image: "https://www.spacex.com/static/images/share.jpg",
    },
    redirectUri: "https://mysaas.com/dashboard",
    settings: {
      unifiedApis: [
        "crm",
      ],
    },
    theme: {
      favicon: "https://res.cloudinary.com/apideck/icons/intercom",
      logo: "https://res.cloudinary.com/apideck/icons/intercom",
      primaryColor: "#286efa",
      sidepanelBackgroundColor: "#286efa",
      sidepanelTextColor: "#FFFFFF",
      vaultName: "Intercom",
      privacyUrl: "https://compliance.apideck.com/privacy-policy",
      termsUrl:
        "https://www.termsfeed.com/terms-conditions/957c85c1b089ae9e3219c83eff65377e",
    },
    customConsumerSettings: {
      "feature_flag_1": true,
      "tax_rates": [
        {
          "id": "6",
          "label": "6%",
        },
        {
          "id": "21",
          "label": "21%",
        },
      ],
    },
  },
};

Fields

Field	Type	Required	Description	Example
consumerId	string	➖	ID of the consumer which you want to get or push data from	test-consumer
appId	string	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
session	components.Session	➖	Additional redirect uri and/or consumer metadata