PersonalCredentialStatusResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/stormmcp/json-schema/stormmcp-personal-credential-status-response-schema.json",
  "title": "PersonalCredentialStatusResponse",
  "description": "Response model for the personal credential status check.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stormmcp-integrations-api-openapi.yml#/components/schemas/PersonalCredentialStatusResponse",
  "type": "object",
  "properties": {
    "hasCredential": {
      "type": "boolean",
      "description": "Gets a value indicating whether the current user has a personal credential for this library."
    },
    "credentialId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Gets the credential ID (for disconnect). Null when bool PersonalCredentialStatusResponse.HasCredential is false."
    },
    "providerConfigId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Gets the UCS provider config ID that this credential belongs to."
    },
    "state": {
      "description": "Gets the unified connection state — the FE-aligned ubiquitous-language\nprojection of (credential presence, validity). Single source of truth.\nAlways present on the wire; defaults to McpConnectionState McpConnectionState.NeedsSetup.",
      "$ref": "#/$defs/McpConnectionState"
    },
    "grantType": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "description": "Gets the normalized grant type (`ClientCredentials` / `AuthorizationCode`),\nor null when the server is not OAuth. Typed so the finite vocabulary reaches the\ngenerated client; the wire form is unchanged (enums serialize as their name).",
          "$ref": "#/$defs/OAuthGrantType"
        }
      ]
    }
  },
  "$defs": {
    "McpConnectionOutcome": {
      "type": "integer",
      "description": "            Coarse outcome of an MCP server's connection state — the FE-aligned ubiquitous\n            language used end-to-end across BE and FE to drive UI affordances.\n            One outcome per state; string? McpConnectionState.Reason refines an\nMcpConnectionOutcome.Error outcome with a machine-readable code from\nMcpConnectionReasons."
    },
    "McpConnectionState": {
      "type": "object",
      "properties": {
        "outcome": {
          "description": "Gets the coarse outcome — the ubiquitous language shared across BE and FE.",
          "$ref": "#/$defs/McpConnectionOutcome"
        },
        "disabled": {
          "type": "boolean",
          "description": "Gets a value indicating whether an admin has disabled this integration at\nthe tenant level. Orthogonal to McpConnectionOutcome McpConnectionState.Outcome: the outcome still\nreflects the underlying connection readiness, so re-enabling needs no\nre-derivation. Only a configured row can be disabled."
        },
        "reason": {
          "type": [
            "null",
            "string"
          ],
          "description": "Gets the machine-readable reason from McpConnectionReasons,\nor null when none applies. Set for McpConnectionOutcome.Error,\nfor Connected plus string McpConnectionReasons.RefreshPending, and\nfor NeedsSetup plus\nstring McpConnectionReasons.SchemaCredentialNotConfigured."
        },
        "reasonDetails": {
          "type": [
            "null",
            "string"
          ],
          "description": "Gets optional developer-facing detail refining the reason (e.g. UCS error\ncode, exception message). May be surfaced in logs and ProblemDetails but\nmust not be used for end-user UI strings."
        },
        "interactiveAvailable": {
          "type": [
            "null",
            "boolean"
          ],
          "description": "Gets a value indicating whether an interactive personal-OAuth connect,\nsetup, or reconnect can clear this classification. Present as\n`true` only for `not_configured`,\n`awaiting_credentials`, `credential_invalid`, and\n`misconfigured` when the primary credential of an interactive\npersonal-OAuth source is the cause. Absent (`null`) for\nnon-interactive sources, Connected results, and reasons a primary\nconnect cannot clear. Never `false`."
        },
        "recoveryCommand": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "description": "Gets the recovery action for this classification. Null on an unstamped\nsingleton (omitted from JSON and gRPC). A stamped wire state always\ncarries a value other than RecoveryCommand.Unspecified.\nAbsent means the client keeps today's derivation. Present is authoritative\nand replaces reading string? McpConnectionState.Reason to choose Connect, Reconnect,\nConfigure, or Save credential.",
              "$ref": "#/$defs/RecoveryCommand"
            }
          ]
        }
      },
      "description": "            State-only view of an MCP server connection — the wire-shape primitive that\n            every transport (REST, gRPC, SignalR push, future Orleans grain messages)\n            can carry without dragging the entire `McpServerConfiguration`\n            along. The build-outcome wrapper `McpConnectionResult` composes a\n            state with the optional built configuration.\n            Shape contract:* McpConnectionOutcome McpConnectionState.Outcome is always set.\n* string? McpConnectionState.Reason is set when\n                McpConnectionOutcome McpConnectionState.Outcome is McpConnectionOutcome.Error (from\n                McpConnectionReasons), when McpConnectionOutcome McpConnectionState.Outcome is\n                McpConnectionOutcome.Connected and the value is\n                string McpConnectionReasons.RefreshPending, or when\n                McpConnectionOutcome McpConnectionState.Outcome is McpConnectionOutcome.NeedsSetup\n                and the value is\n                string McpConnectionReasons.SchemaCredentialNotConfigured. Other\n                Connected and NeedsSetup results keep string? McpConnectionState.Reason null.\n                Unknown non-error reasons are informational and never a gate.\n* string? McpConnectionState.ReasonDetails is an optional human-readable refinement\n                (UCS error code, exception message) intended for logs and developer-facing\n                diagnostics — not for end-user UI strings.\n* Exception? McpConnectionState.Error is the original exception when the outcome was\n                caused by one. Internal use only — never serialized.\n* bool McpConnectionState.Disabled is an orthogonal admin-disable flag — it can\n                be true alongside any McpConnectionOutcome McpConnectionState.Outcome (a Connected or NeedsAuth\n                server can still be admin-disabled), so it does not collapse into the\n                readiness outcome.\n* bool? McpConnectionState.InteractiveAvailable is present (`true`)\n                only for a user-recoverable classification of an interactive personal-OAuth\n                source. It is omitted (`null`) otherwise and is never\n                `false`.\n* RecoveryCommand? McpConnectionState.RecoveryCommand is the recovery action. It is omitted\n                (`null`) on an unstamped singleton so an old payload stays\n                absent. A present value is authoritative. RecoveryCommand.Unspecified\n                is never stored."
    },
    "OAuthGrantType": {
      "type": "integer"
    },
    "RecoveryCommand": {
      "type": "integer"
    }
  }
}