Vapi · Schema

OAuth2AuthenticationPlan

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
type	string
url	string	This is the OAuth2 URL.
clientId	string	This is the OAuth2 client ID.
clientSecret	string	This is the OAuth2 client secret.
scope	string	This is the scope of the OAuth2 token.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OAuth2AuthenticationPlan",
  "title": "OAuth2AuthenticationPlan",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "oauth2"
      ]
    },
    "url": {
      "type": "string",
      "description": "This is the OAuth2 URL."
    },
    "clientId": {
      "type": "string",
      "description": "This is the OAuth2 client ID."
    },
    "clientSecret": {
      "type": "string",
      "description": "This is the OAuth2 client secret."
    },
    "scope": {
      "type": "string",
      "description": "This is the scope of the OAuth2 token.",
      "maxLength": 1000
    }
  },
  "required": [
    "type",
    "url",
    "clientId",
    "clientSecret"
  ]
}