AuthObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/asapp3/json-schema/asapp3-auth-object-schema.json",
  "title": "AuthObject",
  "description": "Contains authentication information for a customer in a conversation.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/asapp3-conversations-api-openapi.yml#/components/schemas/AuthObject",
  "type": "object",
  "properties": {
    "streamId": {
      "type": "string",
      "description": "The unique identifier for the connection where responses should be sent."
    },
    "customerExternalId": {
      "type": "string",
      "description": "The unique identifier for the customer in your external system."
    },
    "auth": {
      "type": "object",
      "description": "An authentication payload that could contain different types of credentials, such as a token, used to \nauthenticate an end user. All of the fields are optional, but at least one will be required\n",
      "minProperties": 1,
      "properties": {
        "body": {
          "type": "object",
          "description": "Any authentication data to be sent in the request body, if applicable."
        },
        "cookies": {
          "type": "object",
          "description": "Any authentication data to be sent as cookies, if applicable."
        },
        "headers": {
          "type": "object",
          "description": "Any authentication data to be sent in the request headers, if applicable."
        },
        "token": {
          "type": "string",
          "description": "An authentication token for the user, if applicable."
        }
      }
    }
  },
  "required": [
    "customerExternalId",
    "auth"
  ]
}