@meshery/schemas 1.3.121 → 1.3.123

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -23,7 +23,7 @@ export interface paths {
23
23
  *
24
24
  * Every connection belongs to exactly one organization. The server assigns `organizationId` from the session (`X-Current-Orgid`, then the caller's selected organization) and does not accept it in the body. When the session names none, the server may use the caller's only organization (Meshery Cloud: the only live organization the caller belongs to, else the only one of those the caller owns); it must not guess between several, and answers 400 instead.
25
25
  *
26
- * Desktop registration uses this shared operation, but kind `desktop` is implemented by Cloud: a server that does not support it rejects a `desktop` body with `400`. The heartbeat and deregistration routes are Cloud-only. A client desktop app install registers itself on every connect to Cloud, sign-in included, with kind `desktop`, type `platform`, sub_type `management`, status `connected`, and `metadata` matching `DesktopConnectionMetadata`. Servers implementing this contract must take the organization from the `X-Current-Orgid` header, refuse a `desktop` registration without it with `400`, and refuse a caller who is not a live member of that organization with `403`. They must deduplicate on (organization, owner, `metadata.installationId`): registering the same install again updates that connection and returns `200`, while a new connection returns `201`. A `desktop` body whose metadata lacks `installationId` is refused with `400`. Installs on one computer share `metadata.computerId`, so a server can group them by computer. The kind names the connection type, never the product that runs on the machine.
26
+ * Desktop registration uses this shared operation, but kind `desktop` is implemented by Cloud: a server that does not support it rejects a `desktop` body with `400`. The heartbeat and deregistration routes are Cloud-only. A client desktop app install registers itself on every connect to Cloud, sign-in included, with kind `desktop`, type `platform`, sub_type `management`, status `connected`, and `metadata` matching `DesktopConnectionMetadata`. Servers implementing this contract must take the organization from the `X-Current-Orgid` header, refuse a `desktop` registration without it with `400`, and refuse a caller who is not a live member of that organization with `403`. They must deduplicate on (organization, owner, `metadata.installationId`): registering the same install again updates that connection and returns `200`, while a new connection returns `201`. A repeat registration carries the stored `metadata.platformSessions` and `metadata.platformSessionsReportedAt` forward from the stored row: it can neither set nor erase them. A `desktop` body whose metadata lacks `installationId` is refused with `400`. Installs on one computer share `metadata.computerId`, so a server can group them by computer. The kind names the connection type, never the product that runs on the machine.
27
27
  *
28
28
  * A `desktop` registration whose `metadata.clientName` and `metadata.appVersion` fall below the server's minimum version for that client is refused with `426` and a `ClientUpgradeRequiredError` body; the connection, when it exists, is set to `maintenance`. Servers must link the API token that authenticated the registration to the connection (`metadata.tokenId`, server-written) and revoke that token when the connection is deregistered or deleted. When a later registration of the same connection authenticates with a different token, the server revokes the token previously linked to it. One sign-in can back one install's connections in several organizations, so a token is revoked only once no live connection of the same owner still links it: removing or superseding one organization's connection must not sign the install out of another. Registrations beyond the organization's device limit are accepted; the organization is flagged through the capabilities document's `session.deviceUsage` instead.
29
29
  */
@@ -88,7 +88,7 @@ export interface paths {
88
88
  get: operations["getConnectionById"];
89
89
  /**
90
90
  * Update a connection
91
- * @description Update an existing connection. Meshery Cloud refuses, with a `409` MeshKit error naming the reserved identity, an edit that would give a connection the GitHub App connection's identity (name `GitHub App`, sub_type `git`). On the GitHub App connection itself, the server-written metadata keys `installations`, `installationId` and `installationsVerifiedAt` are carried forward from the stored row: a client edit can neither set nor erase them (other metadata keys are written as sent). Their shape is `GithubConnectionMetadata` in the v1beta3 `github` construct. `organizationId` is not in the body. The server keeps the organization assigned at registration.
91
+ * @description Update an existing connection. Meshery Cloud refuses, with a `409` MeshKit error naming the reserved identity, an edit that would give a connection the GitHub App connection's identity (name `GitHub App`, sub_type `git`). On the GitHub App connection itself, the server-written metadata keys `installations`, `installationId` and `installationsVerifiedAt` are carried forward from the stored row: a client edit can neither set nor erase them (other metadata keys are written as sent). Their shape is `GithubConnectionMetadata` in the v1beta3 `github` construct. On a `desktop` connection the server-written metadata keys `tokenId`, `lastSeenAt`, `platformSessions` and `platformSessionsReportedAt` are likewise carried forward from the stored row: an edit can neither set nor erase them, so a report can only be written through `reportDesktopPlatformSessions`. `organizationId` is not in the body. The server keeps the organization assigned at registration.
92
92
  */
93
93
  put: operations["updateConnection"];
94
94
  post?: never;
@@ -182,6 +182,48 @@ export interface paths {
182
182
  patch?: never;
183
183
  trace?: never;
184
184
  };
185
+ "/api/integrations/connections/desktop/{installationId}/platform-sessions": {
186
+ parameters: {
187
+ query?: never;
188
+ header?: never;
189
+ path?: never;
190
+ cookie?: never;
191
+ };
192
+ get?: never;
193
+ /**
194
+ * Report which social accounts a desktop install is signed in to
195
+ * @description A desktop app install reports, for the computer it runs on, each browser sign-in it has checked: the platform, the account handle, the Blowhorn profile and Chrome profile that hold it, and when the sign-in was last verified. Servers implementing this contract must store the report as `metadata.platformSessions` of the caller's `desktop` connection whose `metadata.installationId` matches, replace any earlier report in full (an empty `sessions` array clears it), and set `metadata.platformSessionsReportedAt` to the current time. The report is the only writer of those two fields: a `desktop` registration ignores a value for either, as it ignores `tokenId`. Servers must scope the write to the caller: a connection registered by another user is not found. An install registers one connection per organization, so the report applies to the install's connection in the session organization (`X-Current-Orgid`, then the caller's selected organization), and the caller must be a live member of it: a caller who is not, or who has no such connection there, receives `404` and nothing is stored. A token bound only to the hosted MCP resource (scope `connections:read`) is refused with `403`: no tool writes. The report carries no cookie, token, credential or Google account email, and servers must refuse a body that carries any key the schema does not name. Servers must also refuse with `400` a report that lists two sessions with the same `platform` and `handle`, handles compared case-insensitively (or two without a `handle` on one platform), and a `socialConnectionId` that does not name a connection of the session organization the caller may see. When nothing matches, the server answers 404 and stores nothing.
196
+ */
197
+ put: operations["reportDesktopPlatformSessions"];
198
+ post?: never;
199
+ delete?: never;
200
+ options?: never;
201
+ head?: never;
202
+ patch?: never;
203
+ trace?: never;
204
+ };
205
+ "/api/integrations/platform-sessions": {
206
+ parameters: {
207
+ query?: never;
208
+ header?: never;
209
+ path?: never;
210
+ cookie?: never;
211
+ };
212
+ /**
213
+ * Find where a social account is signed in
214
+ * @description Answers "where is this social account signed in?": for each desktop install that reported a browser sign-in matching the filters, returns the computer (connection id, install id, host name, status and last heartbeat) and the session it reported (platform, handle, state, when it was last verified, the Blowhorn profile and the Chrome profile that hold it, and the connection of the account itself). Servers implementing this contract read `metadata.platformSessions` of the session organization's live `desktop` connections and return of their metadata only those sessions, `platformSessionsReportedAt`, `hostname`, `os` and `lastSeenAt`, never any other part of it, a credential, a cookie, a token or a Google account email. The `status` and `lastSeenAt` of the computer follow the heartbeat rule of `recordConnectionHeartbeat`, so a client can tell a session reported by a computer that is offline now. A caller sees the connections it owns and, when it is an organization admin, every connection in the organization: the visibility rule of `DesktopConnectionMetadata`. Rows are ordered by `lastVerifiedAt` (a time the install reported, by its own clock), newest first, then by `connectionId`, `platform` and `handle`, so pages are stable.
215
+ *
216
+ * Tenancy is enforced by the server that implements this contract (Blowhorn Cloud), never by a client, a gateway or an MCP tool, which pass the caller's identity and the organization selector through unchanged. The server runs the same organization membership and permission checks as `getConnections`, keyed by the permission `View Connections` (Workspace Management), the one behind the `connections:read` scope, for the organization named by `X-Current-Orgid` (for the hosted MCP tool, the optional `organizationId` argument), else the caller's selected organization: a caller who is not a live member of that organization receives `404`, the same answer as for an unknown organization, and a member without that permission is refused with `403`. It returns only sessions reported by `desktop` connections of that organization that the caller may see, and never one of another user's installs unless the caller administers the organization. A filter never widens the scope: `installationId` naming an install the caller may not see matches nothing. `totalCount` counts only rows the caller may see, after that scoping and every filter, so it never reveals another user's installs.
217
+ */
218
+ get: operations["getPlatformSessions"];
219
+ put?: never;
220
+ post?: never;
221
+ delete?: never;
222
+ options?: never;
223
+ head?: never;
224
+ patch?: never;
225
+ trace?: never;
226
+ };
185
227
  "/api/integrations/connections/{connectionId}/heartbeat": {
186
228
  parameters: {
187
229
  query?: never;
@@ -1411,6 +1453,391 @@ export interface components {
1411
1453
  * @description Server time of the last registration or heartbeat.
1412
1454
  */
1413
1455
  lastSeenAt?: string;
1456
+ /** @description Browser sign-ins of one install, at most one per platform and handle, handles compared case-insensitively. */
1457
+ platformSessions?: {
1458
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1459
+ platform: string;
1460
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1461
+ handle?: string;
1462
+ /**
1463
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1464
+ * @enum {string}
1465
+ */
1466
+ state: "signed_in" | "signed_out" | "unknown";
1467
+ /**
1468
+ * Format: date-time
1469
+ * @description When the install last checked this sign-in, as the install read it.
1470
+ */
1471
+ lastVerifiedAt: string;
1472
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1473
+ blowhornProfile?: string;
1474
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1475
+ chromeProfile?: {
1476
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1477
+ directory: string;
1478
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1479
+ displayName?: string;
1480
+ };
1481
+ /**
1482
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1483
+ * @enum {string}
1484
+ */
1485
+ identity?: "ok" | "drift" | "missing" | "unknown";
1486
+ /**
1487
+ * Format: uuid
1488
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1489
+ */
1490
+ socialConnectionId?: string;
1491
+ }[];
1492
+ /**
1493
+ * Format: date-time
1494
+ * @description Server time of the report in `platformSessions`. A value sent in a registration or an update is ignored, and the stored value is carried forward.
1495
+ */
1496
+ platformSessionsReportedAt?: string;
1497
+ };
1498
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1499
+ PlatformSessionPlatform: string;
1500
+ /**
1501
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1502
+ * @enum {string}
1503
+ */
1504
+ PlatformSessionState: "signed_in" | "signed_out" | "unknown";
1505
+ /**
1506
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1507
+ * @enum {string}
1508
+ */
1509
+ PlatformSessionIdentity: "ok" | "drift" | "missing" | "unknown";
1510
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1511
+ PlatformSessionChromeProfile: {
1512
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1513
+ directory: string;
1514
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1515
+ displayName?: string;
1516
+ };
1517
+ /** @description One browser sign-in a desktop install checked: an account on a platform, whether it is signed in, when that was last verified, and where on the computer it lives. Carries no cookie, token, credential or Google account email. */
1518
+ PlatformSession: {
1519
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1520
+ platform: string;
1521
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1522
+ handle?: string;
1523
+ /**
1524
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1525
+ * @enum {string}
1526
+ */
1527
+ state: "signed_in" | "signed_out" | "unknown";
1528
+ /**
1529
+ * Format: date-time
1530
+ * @description When the install last checked this sign-in, as the install read it.
1531
+ */
1532
+ lastVerifiedAt: string;
1533
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1534
+ blowhornProfile?: string;
1535
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1536
+ chromeProfile?: {
1537
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1538
+ directory: string;
1539
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1540
+ displayName?: string;
1541
+ };
1542
+ /**
1543
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1544
+ * @enum {string}
1545
+ */
1546
+ identity?: "ok" | "drift" | "missing" | "unknown";
1547
+ /**
1548
+ * Format: uuid
1549
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1550
+ */
1551
+ socialConnectionId?: string;
1552
+ };
1553
+ /** @description Browser sign-ins of one install, at most one per platform and handle, handles compared case-insensitively. */
1554
+ PlatformSessionList: {
1555
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1556
+ platform: string;
1557
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1558
+ handle?: string;
1559
+ /**
1560
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1561
+ * @enum {string}
1562
+ */
1563
+ state: "signed_in" | "signed_out" | "unknown";
1564
+ /**
1565
+ * Format: date-time
1566
+ * @description When the install last checked this sign-in, as the install read it.
1567
+ */
1568
+ lastVerifiedAt: string;
1569
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1570
+ blowhornProfile?: string;
1571
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1572
+ chromeProfile?: {
1573
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1574
+ directory: string;
1575
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1576
+ displayName?: string;
1577
+ };
1578
+ /**
1579
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1580
+ * @enum {string}
1581
+ */
1582
+ identity?: "ok" | "drift" | "missing" | "unknown";
1583
+ /**
1584
+ * Format: uuid
1585
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1586
+ */
1587
+ socialConnectionId?: string;
1588
+ }[];
1589
+ /** @description The body a desktop install sends to report its browser sign-ins. It replaces the earlier report in full. */
1590
+ PlatformSessionsReport: {
1591
+ /** @description Browser sign-ins of one install, at most one per platform and handle, handles compared case-insensitively. */
1592
+ sessions: {
1593
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1594
+ platform: string;
1595
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1596
+ handle?: string;
1597
+ /**
1598
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1599
+ * @enum {string}
1600
+ */
1601
+ state: "signed_in" | "signed_out" | "unknown";
1602
+ /**
1603
+ * Format: date-time
1604
+ * @description When the install last checked this sign-in, as the install read it.
1605
+ */
1606
+ lastVerifiedAt: string;
1607
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1608
+ blowhornProfile?: string;
1609
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1610
+ chromeProfile?: {
1611
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1612
+ directory: string;
1613
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1614
+ displayName?: string;
1615
+ };
1616
+ /**
1617
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1618
+ * @enum {string}
1619
+ */
1620
+ identity?: "ok" | "drift" | "missing" | "unknown";
1621
+ /**
1622
+ * Format: uuid
1623
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1624
+ */
1625
+ socialConnectionId?: string;
1626
+ }[];
1627
+ };
1628
+ /** @description The report stored for one desktop install. */
1629
+ DesktopPlatformSessions: {
1630
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
1631
+ installationId: string;
1632
+ /**
1633
+ * Format: date-time
1634
+ * @description Server time the report was stored.
1635
+ */
1636
+ reportedAt: string;
1637
+ /** @description Browser sign-ins of one install, at most one per platform and handle, handles compared case-insensitively. */
1638
+ sessions: {
1639
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1640
+ platform: string;
1641
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1642
+ handle?: string;
1643
+ /**
1644
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1645
+ * @enum {string}
1646
+ */
1647
+ state: "signed_in" | "signed_out" | "unknown";
1648
+ /**
1649
+ * Format: date-time
1650
+ * @description When the install last checked this sign-in, as the install read it.
1651
+ */
1652
+ lastVerifiedAt: string;
1653
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1654
+ blowhornProfile?: string;
1655
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1656
+ chromeProfile?: {
1657
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1658
+ directory: string;
1659
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1660
+ displayName?: string;
1661
+ };
1662
+ /**
1663
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1664
+ * @enum {string}
1665
+ */
1666
+ identity?: "ok" | "drift" | "missing" | "unknown";
1667
+ /**
1668
+ * Format: uuid
1669
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1670
+ */
1671
+ socialConnectionId?: string;
1672
+ }[];
1673
+ };
1674
+ /** @description The computer a session was reported from. Nothing else of the desktop connection's metadata is shown here. */
1675
+ PlatformSessionHost: {
1676
+ /**
1677
+ * Format: uuid
1678
+ * @description The `desktop` connection of the install.
1679
+ */
1680
+ connectionId: string;
1681
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
1682
+ installationId: string;
1683
+ hostname?: string;
1684
+ os?: string;
1685
+ /**
1686
+ * @description Connection Status Value
1687
+ * @enum {string}
1688
+ */
1689
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1690
+ /**
1691
+ * Format: date-time
1692
+ * @description Server time of the connection's last registration or heartbeat.
1693
+ */
1694
+ lastSeenAt?: string;
1695
+ /**
1696
+ * Format: date-time
1697
+ * @description Server time the install's report was stored.
1698
+ */
1699
+ reportedAt?: string;
1700
+ };
1701
+ /** @description One account signed in on one computer. */
1702
+ PlatformSessionLocation: {
1703
+ /** @description The computer a session was reported from. Nothing else of the desktop connection's metadata is shown here. */
1704
+ desktop: {
1705
+ /**
1706
+ * Format: uuid
1707
+ * @description The `desktop` connection of the install.
1708
+ */
1709
+ connectionId: string;
1710
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
1711
+ installationId: string;
1712
+ hostname?: string;
1713
+ os?: string;
1714
+ /**
1715
+ * @description Connection Status Value
1716
+ * @enum {string}
1717
+ */
1718
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1719
+ /**
1720
+ * Format: date-time
1721
+ * @description Server time of the connection's last registration or heartbeat.
1722
+ */
1723
+ lastSeenAt?: string;
1724
+ /**
1725
+ * Format: date-time
1726
+ * @description Server time the install's report was stored.
1727
+ */
1728
+ reportedAt?: string;
1729
+ };
1730
+ /** @description One browser sign-in a desktop install checked: an account on a platform, whether it is signed in, when that was last verified, and where on the computer it lives. Carries no cookie, token, credential or Google account email. */
1731
+ session: {
1732
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1733
+ platform: string;
1734
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1735
+ handle?: string;
1736
+ /**
1737
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1738
+ * @enum {string}
1739
+ */
1740
+ state: "signed_in" | "signed_out" | "unknown";
1741
+ /**
1742
+ * Format: date-time
1743
+ * @description When the install last checked this sign-in, as the install read it.
1744
+ */
1745
+ lastVerifiedAt: string;
1746
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1747
+ blowhornProfile?: string;
1748
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1749
+ chromeProfile?: {
1750
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1751
+ directory: string;
1752
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1753
+ displayName?: string;
1754
+ };
1755
+ /**
1756
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1757
+ * @enum {string}
1758
+ */
1759
+ identity?: "ok" | "drift" | "missing" | "unknown";
1760
+ /**
1761
+ * Format: uuid
1762
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1763
+ */
1764
+ socialConnectionId?: string;
1765
+ };
1766
+ };
1767
+ /** @description Page of the places matching accounts are signed in. */
1768
+ PlatformSessionLocationPage: {
1769
+ /** @description Matches on this page. */
1770
+ locations: {
1771
+ /** @description The computer a session was reported from. Nothing else of the desktop connection's metadata is shown here. */
1772
+ desktop: {
1773
+ /**
1774
+ * Format: uuid
1775
+ * @description The `desktop` connection of the install.
1776
+ */
1777
+ connectionId: string;
1778
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
1779
+ installationId: string;
1780
+ hostname?: string;
1781
+ os?: string;
1782
+ /**
1783
+ * @description Connection Status Value
1784
+ * @enum {string}
1785
+ */
1786
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1787
+ /**
1788
+ * Format: date-time
1789
+ * @description Server time of the connection's last registration or heartbeat.
1790
+ */
1791
+ lastSeenAt?: string;
1792
+ /**
1793
+ * Format: date-time
1794
+ * @description Server time the install's report was stored.
1795
+ */
1796
+ reportedAt?: string;
1797
+ };
1798
+ /** @description One browser sign-in a desktop install checked: an account on a platform, whether it is signed in, when that was last verified, and where on the computer it lives. Carries no cookie, token, credential or Google account email. */
1799
+ session: {
1800
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
1801
+ platform: string;
1802
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
1803
+ handle?: string;
1804
+ /**
1805
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
1806
+ * @enum {string}
1807
+ */
1808
+ state: "signed_in" | "signed_out" | "unknown";
1809
+ /**
1810
+ * Format: date-time
1811
+ * @description When the install last checked this sign-in, as the install read it.
1812
+ */
1813
+ lastVerifiedAt: string;
1814
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
1815
+ blowhornProfile?: string;
1816
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
1817
+ chromeProfile?: {
1818
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
1819
+ directory: string;
1820
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
1821
+ displayName?: string;
1822
+ };
1823
+ /**
1824
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
1825
+ * @enum {string}
1826
+ */
1827
+ identity?: "ok" | "drift" | "missing" | "unknown";
1828
+ /**
1829
+ * Format: uuid
1830
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
1831
+ */
1832
+ socialConnectionId?: string;
1833
+ };
1834
+ }[];
1835
+ /** @description Total number of matches on all pages. */
1836
+ totalCount: number;
1837
+ /** @description Current page number. */
1838
+ page: number;
1839
+ /** @description Number of elements per page. */
1840
+ pageSize: number;
1414
1841
  };
1415
1842
  /**
1416
1843
  * @description Connection Status Value
@@ -5438,6 +5865,341 @@ export interface operations {
5438
5865
  };
5439
5866
  };
5440
5867
  };
5868
+ reportDesktopPlatformSessions: {
5869
+ parameters: {
5870
+ query?: never;
5871
+ header?: {
5872
+ /** @description Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies. */
5873
+ "X-Current-Orgid"?: string;
5874
+ };
5875
+ path: {
5876
+ /** @description Installation identifier from `metadata.installationId`. */
5877
+ installationId: string;
5878
+ };
5879
+ cookie?: never;
5880
+ };
5881
+ requestBody: {
5882
+ content: {
5883
+ "application/json": {
5884
+ /** @description Browser sign-ins of one install, at most one per platform and handle, handles compared case-insensitively. */
5885
+ sessions: {
5886
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
5887
+ platform: string;
5888
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
5889
+ handle?: string;
5890
+ /**
5891
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
5892
+ * @enum {string}
5893
+ */
5894
+ state: "signed_in" | "signed_out" | "unknown";
5895
+ /**
5896
+ * Format: date-time
5897
+ * @description When the install last checked this sign-in, as the install read it.
5898
+ */
5899
+ lastVerifiedAt: string;
5900
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
5901
+ blowhornProfile?: string;
5902
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
5903
+ chromeProfile?: {
5904
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
5905
+ directory: string;
5906
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
5907
+ displayName?: string;
5908
+ };
5909
+ /**
5910
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
5911
+ * @enum {string}
5912
+ */
5913
+ identity?: "ok" | "drift" | "missing" | "unknown";
5914
+ /**
5915
+ * Format: uuid
5916
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
5917
+ */
5918
+ socialConnectionId?: string;
5919
+ }[];
5920
+ };
5921
+ };
5922
+ };
5923
+ responses: {
5924
+ /** @description The stored report */
5925
+ 200: {
5926
+ headers: {
5927
+ [name: string]: unknown;
5928
+ };
5929
+ content: {
5930
+ "application/json": {
5931
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
5932
+ installationId: string;
5933
+ /**
5934
+ * Format: date-time
5935
+ * @description Server time the report was stored.
5936
+ */
5937
+ reportedAt: string;
5938
+ /** @description Browser sign-ins of one install, at most one per platform and handle, handles compared case-insensitively. */
5939
+ sessions: {
5940
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
5941
+ platform: string;
5942
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
5943
+ handle?: string;
5944
+ /**
5945
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
5946
+ * @enum {string}
5947
+ */
5948
+ state: "signed_in" | "signed_out" | "unknown";
5949
+ /**
5950
+ * Format: date-time
5951
+ * @description When the install last checked this sign-in, as the install read it.
5952
+ */
5953
+ lastVerifiedAt: string;
5954
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
5955
+ blowhornProfile?: string;
5956
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
5957
+ chromeProfile?: {
5958
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
5959
+ directory: string;
5960
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
5961
+ displayName?: string;
5962
+ };
5963
+ /**
5964
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
5965
+ * @enum {string}
5966
+ */
5967
+ identity?: "ok" | "drift" | "missing" | "unknown";
5968
+ /**
5969
+ * Format: uuid
5970
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
5971
+ */
5972
+ socialConnectionId?: string;
5973
+ }[];
5974
+ };
5975
+ };
5976
+ };
5977
+ /** @description Invalid request body or request param */
5978
+ 400: {
5979
+ headers: {
5980
+ [name: string]: unknown;
5981
+ };
5982
+ content: {
5983
+ "text/plain": string;
5984
+ };
5985
+ };
5986
+ /** @description Expired JWT token used or insufficient privilege */
5987
+ 401: {
5988
+ headers: {
5989
+ [name: string]: unknown;
5990
+ };
5991
+ content: {
5992
+ "text/plain": string;
5993
+ };
5994
+ };
5995
+ /** @description Forbidden */
5996
+ 403: {
5997
+ headers: {
5998
+ [name: string]: unknown;
5999
+ };
6000
+ content: {
6001
+ "text/plain": string;
6002
+ };
6003
+ };
6004
+ /** @description Result not found */
6005
+ 404: {
6006
+ headers: {
6007
+ [name: string]: unknown;
6008
+ };
6009
+ content: {
6010
+ "text/plain": string;
6011
+ };
6012
+ };
6013
+ /** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
6014
+ 429: {
6015
+ headers: {
6016
+ /** @description Number of seconds the caller must wait before retrying. */
6017
+ "Retry-After": number;
6018
+ [name: string]: unknown;
6019
+ };
6020
+ content: {
6021
+ "application/json": {
6022
+ /** @description The sentence the caller is shown. */
6023
+ error: string;
6024
+ /** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
6025
+ code?: string;
6026
+ /**
6027
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
6028
+ * @enum {string}
6029
+ */
6030
+ severity?: "emergency" | "alert" | "critical" | "fatal";
6031
+ /** @description MeshKit's probable causes of the error. */
6032
+ probableCause?: string[];
6033
+ /** @description MeshKit's suggested remediations for the error. */
6034
+ suggestedRemediation?: string[];
6035
+ };
6036
+ };
6037
+ };
6038
+ /** @description Internal server error */
6039
+ 500: {
6040
+ headers: {
6041
+ [name: string]: unknown;
6042
+ };
6043
+ content: {
6044
+ "text/plain": string;
6045
+ };
6046
+ };
6047
+ };
6048
+ };
6049
+ getPlatformSessions: {
6050
+ parameters: {
6051
+ query?: {
6052
+ /** @description Page number */
6053
+ page?: number;
6054
+ /** @description Number of items per page */
6055
+ pageSize?: number;
6056
+ /** @description Only sessions on this platform, for example `x`, `linkedin` or `reddit`. */
6057
+ platform?: string;
6058
+ /** @description Only sessions of this account handle, compared case-insensitively and without a leading `@`, for example `blowhorn_ai`. */
6059
+ handle?: string;
6060
+ /** @description Only sessions in this state, for example `signed_in`. */
6061
+ state?: "signed_in" | "signed_out" | "unknown";
6062
+ /** @description Only sessions reported by this desktop install. */
6063
+ installationId?: string;
6064
+ };
6065
+ header?: {
6066
+ /** @description Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies. */
6067
+ "X-Current-Orgid"?: string;
6068
+ };
6069
+ path?: never;
6070
+ cookie?: never;
6071
+ };
6072
+ requestBody?: never;
6073
+ responses: {
6074
+ /** @description Where the matching accounts are signed in */
6075
+ 200: {
6076
+ headers: {
6077
+ [name: string]: unknown;
6078
+ };
6079
+ content: {
6080
+ "application/json": {
6081
+ /** @description Matches on this page. */
6082
+ locations: {
6083
+ /** @description The computer a session was reported from. Nothing else of the desktop connection's metadata is shown here. */
6084
+ desktop: {
6085
+ /**
6086
+ * Format: uuid
6087
+ * @description The `desktop` connection of the install.
6088
+ */
6089
+ connectionId: string;
6090
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
6091
+ installationId: string;
6092
+ hostname?: string;
6093
+ os?: string;
6094
+ /**
6095
+ * @description Connection Status Value
6096
+ * @enum {string}
6097
+ */
6098
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
6099
+ /**
6100
+ * Format: date-time
6101
+ * @description Server time of the connection's last registration or heartbeat.
6102
+ */
6103
+ lastSeenAt?: string;
6104
+ /**
6105
+ * Format: date-time
6106
+ * @description Server time the install's report was stored.
6107
+ */
6108
+ reportedAt?: string;
6109
+ };
6110
+ /** @description One browser sign-in a desktop install checked: an account on a platform, whether it is signed in, when that was last verified, and where on the computer it lives. Carries no cookie, token, credential or Google account email. */
6111
+ session: {
6112
+ /** @description A social platform whose sign-in lives in a browser session, lowercase, for example `x`, `linkedin` or `reddit`. */
6113
+ platform: string;
6114
+ /** @description The account handle on the platform, without a leading `@`. Never an email address. Absent when the check could not read it. */
6115
+ handle?: string;
6116
+ /**
6117
+ * @description What the last session check read: `signed_in`, `signed_out`, or `unknown` when the check could not tell (the browser was busy, or the page did not answer).
6118
+ * @enum {string}
6119
+ */
6120
+ state: "signed_in" | "signed_out" | "unknown";
6121
+ /**
6122
+ * Format: date-time
6123
+ * @description When the install last checked this sign-in, as the install read it.
6124
+ */
6125
+ lastVerifiedAt: string;
6126
+ /** @description The name of the Blowhorn profile the account is mapped to on this computer. Never an email address. */
6127
+ blowhornProfile?: string;
6128
+ /** @description The Chrome profile on the computer that holds the sign-in. The Google account email is never part of it. */
6129
+ chromeProfile?: {
6130
+ /** @description Chrome's profile directory name, for example `Profile 1`. */
6131
+ directory: string;
6132
+ /** @description The name Chrome shows for the profile. Never an email address, so a name that holds an `@` is not reported. */
6133
+ displayName?: string;
6134
+ };
6135
+ /**
6136
+ * @description Whether the Chrome profile still shows the account the mapping expects: `ok`, `drift` (a different account), `missing` (nobody is signed in), or `unknown`.
6137
+ * @enum {string}
6138
+ */
6139
+ identity?: "ok" | "drift" | "missing" | "unknown";
6140
+ /**
6141
+ * Format: uuid
6142
+ * @description The id of the connection that is the account itself (kind is the platform), when the account is mapped to a connection.
6143
+ */
6144
+ socialConnectionId?: string;
6145
+ };
6146
+ }[];
6147
+ /** @description Total number of matches on all pages. */
6148
+ totalCount: number;
6149
+ /** @description Current page number. */
6150
+ page: number;
6151
+ /** @description Number of elements per page. */
6152
+ pageSize: number;
6153
+ };
6154
+ };
6155
+ };
6156
+ /** @description Invalid request body or request param */
6157
+ 400: {
6158
+ headers: {
6159
+ [name: string]: unknown;
6160
+ };
6161
+ content: {
6162
+ "text/plain": string;
6163
+ };
6164
+ };
6165
+ /** @description Expired JWT token used or insufficient privilege */
6166
+ 401: {
6167
+ headers: {
6168
+ [name: string]: unknown;
6169
+ };
6170
+ content: {
6171
+ "text/plain": string;
6172
+ };
6173
+ };
6174
+ /** @description Forbidden */
6175
+ 403: {
6176
+ headers: {
6177
+ [name: string]: unknown;
6178
+ };
6179
+ content: {
6180
+ "text/plain": string;
6181
+ };
6182
+ };
6183
+ /** @description Result not found */
6184
+ 404: {
6185
+ headers: {
6186
+ [name: string]: unknown;
6187
+ };
6188
+ content: {
6189
+ "text/plain": string;
6190
+ };
6191
+ };
6192
+ /** @description Internal server error */
6193
+ 500: {
6194
+ headers: {
6195
+ [name: string]: unknown;
6196
+ };
6197
+ content: {
6198
+ "text/plain": string;
6199
+ };
6200
+ };
6201
+ };
6202
+ };
5441
6203
  recordConnectionHeartbeat: {
5442
6204
  parameters: {
5443
6205
  query?: never;