AppListingInstallRequestSchema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getoneprofile-ai/json-schema/getoneprofile-ai-app-listing-install-request-schema-schema.json",
  "title": "AppListingInstallRequestSchema",
  "description": "Request to begin an app listing OAuth install.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getoneprofile-ai-app-listings-api-openapi.yml#/components/schemas/AppListingInstallRequestSchema",
  "properties": {
    "inputs": {
      "additionalProperties": {
        "maxLength": 2048,
        "minLength": 1,
        "type": "string"
      },
      "description": "Connect-time inputs collected before the redirect (tenant address, region, or a choice), keyed by input name. Empty for listings that need no inputs.",
      "propertyNames": {
        "maxLength": 255,
        "minLength": 1
      },
      "title": "Inputs",
      "type": "object"
    },
    "integration_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "For switch/reconnect only: the existing integration to re-authorize in place. Bound into the OAuth state so the claim mutates only this integration. Omit for new connects.",
      "title": "Integration Id"
    },
    "intent": {
      "anyOf": [
        {
          "$ref": "#/$defs/SwitchIntent"
        },
        {
          "type": "null"
        }
      ],
      "description": "For switch/reconnect only: 'switch' (API-key -> one-click) or 'reconnect' (re-authorize). Must be set together with integration_id."
    }
  },
  "type": "object",
  "$defs": {
    "SwitchIntent": {
      "description": "Why an OAuth grant is being captured against an *existing* integration.\n\nSet on an installation whose grant re-authorizes a connection in place rather than creating a\nnew one. ``None`` on a normal new-connect install.",
      "enum": [
        "switch",
        "reconnect"
      ],
      "title": "SwitchIntent",
      "type": "string"
    }
  }
}