Zapier · Schema

_AuthenticationCreateRequest

The object used to create a new Authentication

IntegrationsiPaaS

Properties

Name Type Description
title string The title of the authentication.
app string A canonical App ID, as provided by the `/apps` endpoint.
authentication_fields object Required values to create an authentication. These values will be used by the target integration to successfully create the Authentication. See our Adding an Authentication guide for more information.
View JSON Schema on GitHub

JSON Schema

partner-api--authentication-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "_AuthenticationCreateRequest",
  "description": "The object used to create a new Authentication",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zapier/refs/heads/main/json-schema/partner-api--authentication-create-request-schema.json",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the authentication.",
      "maxLength": 255,
      "example": "Example Name"
    },
    "app": {
      "type": "string",
      "format": "uuid",
      "description": "A canonical App ID, as provided by the `/apps` endpoint.",
      "example": "550e8400-e29b-41d4-a716-446655440000"
    },
    "authentication_fields": {
      "type": "object",
      "additionalProperties": {},
      "description": "Required values to create an authentication. These values will be used by the target integration to successfully create the Authentication. See our Adding an Authentication guide for more information.",
      "example": {}
    }
  },
  "required": [
    "app",
    "authentication_fields",
    "title"
  ]
}