Other/Enode

Link User

v1.0.0

Creates an Enode Link session attached to the provided User ID. If this User does not exist, it will be created. The returned linkState gives the user short-lived access to Enode Link.

Input

{
  "type": "object",
  "properties": {
    "forceLanguage": {
      "type": "string",
      "description": "BCP47 language code - Force the Link UI to prefer the specified language. If omitted, the UI will default to the user's browser default language."
    },
    "linkMultiple": {
      "type": "boolean",
      "description": "Allow multiple car vendors to be linked during a single Link session. Automatically disabled if `vendor` is set."
    },
    "userId": {
      "type": "string"
    },
    "userImage": {
      "type": "string",
      "description": "Full URL to an image that the user would recognize as being their own. This URL is only stored for the duration of the Link session, and is displayed to the user to reduce the effectiveness of phishing attacks."
    },
    "userName": {
      "type": "string",
      "description": "The User's first name, full name, or other identifier that the user would recognize as being their own. This name is only stored for the duration of the Link session, and is displayed to the user to reduce the effectiveness of phishing attacks."
    },
    "vendor": {
      "type": "string",
      "description": "Automatically skip to the credential input screen for this vendor, skipping the Vendor selection menu.",
      "enum": [
        "TESLA",
        "BMW",
        "AUDI",
        "VOLKSWAGEN",
        "HYUNDAI",
        "PEUGEOT",
        "NISSAN"
      ]
    }
  },
  "required": [
    "userId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "linkState": {
      "type": "string"
    }
  }
}