{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/configure-dev/json-schema/configure-dev-sign-in-message-url-request-schema.json",
  "title": "SignInMessageUrlRequest",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/configure-dev-openapi.yml#/components/schemas/SignInMessageUrlRequest",
  "type": "object",
  "required": [
    "channel",
    "subject"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "enum": [
        "signin",
        "reconnect",
        "permissions"
      ],
      "default": "signin"
    },
    "channel": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "subject": {
      "$ref": "#/$defs/SignInMessageUrlSubject"
    },
    "thread": {
      "$ref": "#/$defs/SignInMessageUrlThread"
    },
    "messageSenderProof": {
      "type": "string",
      "maxLength": 8192,
      "description": "Provider-signed evidence that the message sender/thread claim is authentic. A code-bearing URL is returned only when Configure can verify this value."
    },
    "connectors": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "type": "string"
      }
    },
    "displayName": {
      "type": "string",
      "maxLength": 120
    },
    "agentLogo": {
      "type": "string",
      "maxLength": 2048
    },
    "theme": {
      "type": "string",
      "enum": [
        "light",
        "dark"
      ]
    },
    "messageLinePhone": {
      "type": "string",
      "maxLength": 80,
      "description": "Current provider-owned message line that users return to after hosted sign-in. Must already be registered for the acting agent and channel."
    },
    "agentPhone": {
      "type": "string",
      "maxLength": 80,
      "description": "Alias for messageLinePhone. Prefer this when resolving the agent's current line from the messaging provider."
    },
    "messageBody": {
      "type": "string",
      "maxLength": 280,
      "description": "Suggested SMS/iMessage body for returning to the agent."
    },
    "messageCompleteUrl": {
      "type": "string",
      "maxLength": 2048,
      "description": "Optional trusted completion endpoint called by hosted sign-in after approval."
    },
    "journeyId": {
      "type": "string",
      "maxLength": 256,
      "description": "Optional application journey identifier used to map hosted completion back to a message thread."
    },
    "returnMode": {
      "type": "string",
      "enum": [
        "message"
      ],
      "default": "message"
    },
    "idempotencyKey": {
      "type": "string",
      "maxLength": 256
    }
  },
  "$defs": {
    "SignInMessageUrlSubject": {
      "type": "object",
      "required": [
        "key",
        "externalId"
      ],
      "properties": {
        "key": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256,
          "description": "Stable adapter subject key for the message sender."
        },
        "externalId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512,
          "description": "Developer-scoped external ID used before the sender links Configure."
        },
        "senderId": {
          "type": "string",
          "maxLength": 512
        }
      }
    },
    "SignInMessageUrlThread": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "maxLength": 512
        },
        "spaceId": {
          "type": "string",
          "maxLength": 512
        },
        "messageId": {
          "type": "string",
          "maxLength": 512
        }
      }
    }
  }
}