@athenaintel/sdk 4.3.2145 → 4.3.2146
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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/computer/client/Client.d.ts +56 -0
- package/dist/cjs/api/resources/computer/client/Client.js +249 -0
- package/dist/cjs/api/resources/computer/client/requests/GetSshAccessComputerRequest.d.ts +9 -0
- package/dist/cjs/api/resources/computer/client/requests/GetSshAccessComputerRequest.js +3 -0
- package/dist/cjs/api/resources/computer/client/requests/StartComputerComputerRequest.d.ts +9 -0
- package/dist/cjs/api/resources/computer/client/requests/StartComputerComputerRequest.js +3 -0
- package/dist/cjs/api/resources/computer/client/requests/StopComputerComputerRequest.d.ts +9 -0
- package/dist/cjs/api/resources/computer/client/requests/StopComputerComputerRequest.js +3 -0
- package/dist/cjs/api/resources/computer/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +1 -0
- package/dist/cjs/api/resources/users/client/Client.d.ts +45 -1
- package/dist/cjs/api/resources/users/client/Client.js +218 -0
- package/dist/cjs/api/resources/users/client/index.d.ts +1 -1
- package/dist/cjs/api/resources/users/client/index.js +15 -0
- package/dist/cjs/api/resources/users/client/requests/AddSshKeyRequestIn.d.ts +13 -0
- package/dist/cjs/api/resources/users/client/requests/AddSshKeyRequestIn.js +3 -0
- package/dist/cjs/api/resources/users/client/requests/DeleteSshKeyUsersRequest.d.ts +9 -0
- package/dist/cjs/api/resources/users/client/requests/DeleteSshKeyUsersRequest.js +3 -0
- package/dist/cjs/api/resources/users/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/users/client/requests/index.js +2 -0
- package/dist/cjs/api/types/ComputerLifecycleResponseOut.d.ts +11 -0
- package/dist/cjs/api/types/ComputerLifecycleResponseOut.js +3 -0
- package/dist/cjs/api/types/DeleteSshKeyResponseOut.d.ts +7 -0
- package/dist/cjs/api/types/DeleteSshKeyResponseOut.js +3 -0
- package/dist/cjs/api/types/SshAccessInfoOut.d.ts +13 -0
- package/dist/cjs/api/types/SshAccessInfoOut.js +3 -0
- package/dist/cjs/api/types/SshKeyListResponseOut.d.ts +8 -0
- package/dist/cjs/api/types/SshKeyListResponseOut.js +3 -0
- package/dist/cjs/api/types/SshKeyOut.d.ts +19 -0
- package/dist/cjs/api/types/SshKeyOut.js +3 -0
- package/dist/cjs/api/types/index.d.ts +5 -0
- package/dist/cjs/api/types/index.js +5 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/computer/client/Client.d.mts +56 -0
- package/dist/esm/api/resources/computer/client/Client.mjs +249 -0
- package/dist/esm/api/resources/computer/client/requests/GetSshAccessComputerRequest.d.mts +9 -0
- package/dist/esm/api/resources/computer/client/requests/GetSshAccessComputerRequest.mjs +2 -0
- package/dist/esm/api/resources/computer/client/requests/StartComputerComputerRequest.d.mts +9 -0
- package/dist/esm/api/resources/computer/client/requests/StartComputerComputerRequest.mjs +2 -0
- package/dist/esm/api/resources/computer/client/requests/StopComputerComputerRequest.d.mts +9 -0
- package/dist/esm/api/resources/computer/client/requests/StopComputerComputerRequest.mjs +2 -0
- package/dist/esm/api/resources/computer/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/users/client/Client.d.mts +45 -1
- package/dist/esm/api/resources/users/client/Client.mjs +218 -0
- package/dist/esm/api/resources/users/client/index.d.mts +1 -1
- package/dist/esm/api/resources/users/client/index.mjs +1 -1
- package/dist/esm/api/resources/users/client/requests/AddSshKeyRequestIn.d.mts +13 -0
- package/dist/esm/api/resources/users/client/requests/AddSshKeyRequestIn.mjs +2 -0
- package/dist/esm/api/resources/users/client/requests/DeleteSshKeyUsersRequest.d.mts +9 -0
- package/dist/esm/api/resources/users/client/requests/DeleteSshKeyUsersRequest.mjs +2 -0
- package/dist/esm/api/resources/users/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/users/client/requests/index.mjs +1 -0
- package/dist/esm/api/types/ComputerLifecycleResponseOut.d.mts +11 -0
- package/dist/esm/api/types/ComputerLifecycleResponseOut.mjs +2 -0
- package/dist/esm/api/types/DeleteSshKeyResponseOut.d.mts +7 -0
- package/dist/esm/api/types/DeleteSshKeyResponseOut.mjs +2 -0
- package/dist/esm/api/types/SshAccessInfoOut.d.mts +13 -0
- package/dist/esm/api/types/SshAccessInfoOut.mjs +2 -0
- package/dist/esm/api/types/SshKeyListResponseOut.d.mts +8 -0
- package/dist/esm/api/types/SshKeyListResponseOut.mjs +2 -0
- package/dist/esm/api/types/SshKeyOut.d.mts +19 -0
- package/dist/esm/api/types/SshKeyOut.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +5 -0
- package/dist/esm/api/types/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +381 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Result of starting or stopping a computer asset's runtime.
|
|
3
|
+
*/
|
|
4
|
+
export interface ComputerLifecycleResponseOut {
|
|
5
|
+
/** The computer asset id. */
|
|
6
|
+
asset_id: string;
|
|
7
|
+
/** The computer's runtime provider (e.g. `talos_v2`). */
|
|
8
|
+
provider?: string | null;
|
|
9
|
+
/** Runtime state after the operation: `started`, `stopped`, a transitional state such as `restoring`, or `pending` when the transition was durably queued. */
|
|
10
|
+
state: string;
|
|
11
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Where a registered SSH key connects for this computer (identity mode).
|
|
3
|
+
*/
|
|
4
|
+
export interface SshAccessInfoOut {
|
|
5
|
+
/** Ready-to-run `ssh [-p <port>] <asset_id>@<host>`. */
|
|
6
|
+
command: string;
|
|
7
|
+
/** SSH gateway hostname for this environment. */
|
|
8
|
+
host: string;
|
|
9
|
+
/** SSH gateway port. */
|
|
10
|
+
port: number;
|
|
11
|
+
/** The SSH username — the computer's asset id, which selects identity (registered-key) authentication at the gateway. */
|
|
12
|
+
username: string;
|
|
13
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One registered SSH public key.
|
|
3
|
+
*/
|
|
4
|
+
export interface SshKeyOut {
|
|
5
|
+
/** When the key was registered. */
|
|
6
|
+
created_at: string;
|
|
7
|
+
/** ``SHA256:…`` fingerprint, as printed by ``ssh-keygen -lf``. */
|
|
8
|
+
fingerprint: string;
|
|
9
|
+
/** Key id (``ussk_…``); use it to delete the key. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** Key algorithm, e.g. ``ssh-ed25519``. */
|
|
12
|
+
key_type: string;
|
|
13
|
+
/** Display label (defaults to the key comment). */
|
|
14
|
+
label: string;
|
|
15
|
+
/** When the key last authorized an SSH connection, if ever. */
|
|
16
|
+
last_used_at?: string | null;
|
|
17
|
+
/** The key in ``<type> <base64>`` form (no comment). */
|
|
18
|
+
public_key: string;
|
|
19
|
+
}
|
|
@@ -29,6 +29,7 @@ export * from "./ChunkContentItem.mjs";
|
|
|
29
29
|
export * from "./ChunkResult.mjs";
|
|
30
30
|
export * from "./CollabAgentSendMessageResponseOut.mjs";
|
|
31
31
|
export * from "./CollabTokenResponse.mjs";
|
|
32
|
+
export * from "./ComputerLifecycleResponseOut.mjs";
|
|
32
33
|
export * from "./ConversationAssetInfo.mjs";
|
|
33
34
|
export * from "./ConversationMessage.mjs";
|
|
34
35
|
export * from "./ConversationResult.mjs";
|
|
@@ -50,6 +51,7 @@ export * from "./DataFrameRequestOut.mjs";
|
|
|
50
51
|
export * from "./DataFrameUnknownFormatError.mjs";
|
|
51
52
|
export * from "./DefaultVisibility.mjs";
|
|
52
53
|
export * from "./DeleteDataRequest.mjs";
|
|
54
|
+
export * from "./DeleteSshKeyResponseOut.mjs";
|
|
53
55
|
export * from "./DeployComputerResponseOut.mjs";
|
|
54
56
|
export * from "./DimensionProperties.mjs";
|
|
55
57
|
export * from "./DriveAgentResponse.mjs";
|
|
@@ -97,7 +99,10 @@ export * from "./ShareRecipientResultOut.mjs";
|
|
|
97
99
|
export * from "./Sheet.mjs";
|
|
98
100
|
export * from "./SheetOperationResponse.mjs";
|
|
99
101
|
export * from "./SqlAgentResponse.mjs";
|
|
102
|
+
export * from "./SshAccessInfoOut.mjs";
|
|
100
103
|
export * from "./SshAccessResponseOut.mjs";
|
|
104
|
+
export * from "./SshKeyListResponseOut.mjs";
|
|
105
|
+
export * from "./SshKeyOut.mjs";
|
|
101
106
|
export * from "./StructuredDataExtractorResponse.mjs";
|
|
102
107
|
export * from "./TableRowData.mjs";
|
|
103
108
|
export * from "./TextContent.mjs";
|
|
@@ -29,6 +29,7 @@ export * from "./ChunkContentItem.mjs";
|
|
|
29
29
|
export * from "./ChunkResult.mjs";
|
|
30
30
|
export * from "./CollabAgentSendMessageResponseOut.mjs";
|
|
31
31
|
export * from "./CollabTokenResponse.mjs";
|
|
32
|
+
export * from "./ComputerLifecycleResponseOut.mjs";
|
|
32
33
|
export * from "./ConversationAssetInfo.mjs";
|
|
33
34
|
export * from "./ConversationMessage.mjs";
|
|
34
35
|
export * from "./ConversationResult.mjs";
|
|
@@ -50,6 +51,7 @@ export * from "./DataFrameRequestOut.mjs";
|
|
|
50
51
|
export * from "./DataFrameUnknownFormatError.mjs";
|
|
51
52
|
export * from "./DefaultVisibility.mjs";
|
|
52
53
|
export * from "./DeleteDataRequest.mjs";
|
|
54
|
+
export * from "./DeleteSshKeyResponseOut.mjs";
|
|
53
55
|
export * from "./DeployComputerResponseOut.mjs";
|
|
54
56
|
export * from "./DimensionProperties.mjs";
|
|
55
57
|
export * from "./DriveAgentResponse.mjs";
|
|
@@ -97,7 +99,10 @@ export * from "./ShareRecipientResultOut.mjs";
|
|
|
97
99
|
export * from "./Sheet.mjs";
|
|
98
100
|
export * from "./SheetOperationResponse.mjs";
|
|
99
101
|
export * from "./SqlAgentResponse.mjs";
|
|
102
|
+
export * from "./SshAccessInfoOut.mjs";
|
|
100
103
|
export * from "./SshAccessResponseOut.mjs";
|
|
104
|
+
export * from "./SshKeyListResponseOut.mjs";
|
|
105
|
+
export * from "./SshKeyOut.mjs";
|
|
101
106
|
export * from "./StructuredDataExtractorResponse.mjs";
|
|
102
107
|
export * from "./TableRowData.mjs";
|
|
103
108
|
export * from "./TextContent.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.3.
|
|
1
|
+
export declare const SDK_VERSION = "4.3.2146";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.2146";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1634,6 +1634,71 @@ await client.computer.deployComputer({
|
|
|
1634
1634
|
</dl>
|
|
1635
1635
|
|
|
1636
1636
|
|
|
1637
|
+
</dd>
|
|
1638
|
+
</dl>
|
|
1639
|
+
</details>
|
|
1640
|
+
|
|
1641
|
+
<details><summary><code>client.computer.<a href="/src/api/resources/computer/client/Client.ts">getSshAccess</a>({ ...params }) -> AthenaIntelligence.SshAccessInfoOut</code></summary>
|
|
1642
|
+
<dl>
|
|
1643
|
+
<dd>
|
|
1644
|
+
|
|
1645
|
+
#### 📝 Description
|
|
1646
|
+
|
|
1647
|
+
<dl>
|
|
1648
|
+
<dd>
|
|
1649
|
+
|
|
1650
|
+
<dl>
|
|
1651
|
+
<dd>
|
|
1652
|
+
|
|
1653
|
+
Return the SSH gateway host, port, username, and ready-made command for connecting to a computer with a registered SSH public key (see `add_ssh_key`). The username is the computer's asset id; the gateway authorizes the connection against your current edit permission on the computer and starts it if it is stopped. Unlike `create_ssh_access`, this mints nothing and never wakes the computer. Returns 409 when the computer's provider does not support SSH.
|
|
1654
|
+
</dd>
|
|
1655
|
+
</dl>
|
|
1656
|
+
</dd>
|
|
1657
|
+
</dl>
|
|
1658
|
+
|
|
1659
|
+
#### 🔌 Usage
|
|
1660
|
+
|
|
1661
|
+
<dl>
|
|
1662
|
+
<dd>
|
|
1663
|
+
|
|
1664
|
+
<dl>
|
|
1665
|
+
<dd>
|
|
1666
|
+
|
|
1667
|
+
```typescript
|
|
1668
|
+
await client.computer.getSshAccess({
|
|
1669
|
+
asset_id: "asset_id"
|
|
1670
|
+
});
|
|
1671
|
+
|
|
1672
|
+
```
|
|
1673
|
+
</dd>
|
|
1674
|
+
</dl>
|
|
1675
|
+
</dd>
|
|
1676
|
+
</dl>
|
|
1677
|
+
|
|
1678
|
+
#### ⚙️ Parameters
|
|
1679
|
+
|
|
1680
|
+
<dl>
|
|
1681
|
+
<dd>
|
|
1682
|
+
|
|
1683
|
+
<dl>
|
|
1684
|
+
<dd>
|
|
1685
|
+
|
|
1686
|
+
**request:** `AthenaIntelligence.GetSshAccessComputerRequest`
|
|
1687
|
+
|
|
1688
|
+
</dd>
|
|
1689
|
+
</dl>
|
|
1690
|
+
|
|
1691
|
+
<dl>
|
|
1692
|
+
<dd>
|
|
1693
|
+
|
|
1694
|
+
**requestOptions:** `ComputerClient.RequestOptions`
|
|
1695
|
+
|
|
1696
|
+
</dd>
|
|
1697
|
+
</dl>
|
|
1698
|
+
</dd>
|
|
1699
|
+
</dl>
|
|
1700
|
+
|
|
1701
|
+
|
|
1637
1702
|
</dd>
|
|
1638
1703
|
</dl>
|
|
1639
1704
|
</details>
|
|
@@ -1766,6 +1831,136 @@ await client.computer.revokeSshAccess({
|
|
|
1766
1831
|
</dl>
|
|
1767
1832
|
|
|
1768
1833
|
|
|
1834
|
+
</dd>
|
|
1835
|
+
</dl>
|
|
1836
|
+
</details>
|
|
1837
|
+
|
|
1838
|
+
<details><summary><code>client.computer.<a href="/src/api/resources/computer/client/Client.ts">startComputer</a>({ ...params }) -> AthenaIntelligence.ComputerLifecycleResponseOut</code></summary>
|
|
1839
|
+
<dl>
|
|
1840
|
+
<dd>
|
|
1841
|
+
|
|
1842
|
+
#### 📝 Description
|
|
1843
|
+
|
|
1844
|
+
<dl>
|
|
1845
|
+
<dd>
|
|
1846
|
+
|
|
1847
|
+
<dl>
|
|
1848
|
+
<dd>
|
|
1849
|
+
|
|
1850
|
+
Start a stopped computer's runtime and wait for it to come up — the same operation as the Start button in Athena. Idempotent for a running computer. Returns 409 when the computer's provider does not support lifecycle operations.
|
|
1851
|
+
</dd>
|
|
1852
|
+
</dl>
|
|
1853
|
+
</dd>
|
|
1854
|
+
</dl>
|
|
1855
|
+
|
|
1856
|
+
#### 🔌 Usage
|
|
1857
|
+
|
|
1858
|
+
<dl>
|
|
1859
|
+
<dd>
|
|
1860
|
+
|
|
1861
|
+
<dl>
|
|
1862
|
+
<dd>
|
|
1863
|
+
|
|
1864
|
+
```typescript
|
|
1865
|
+
await client.computer.startComputer({
|
|
1866
|
+
asset_id: "asset_id"
|
|
1867
|
+
});
|
|
1868
|
+
|
|
1869
|
+
```
|
|
1870
|
+
</dd>
|
|
1871
|
+
</dl>
|
|
1872
|
+
</dd>
|
|
1873
|
+
</dl>
|
|
1874
|
+
|
|
1875
|
+
#### ⚙️ Parameters
|
|
1876
|
+
|
|
1877
|
+
<dl>
|
|
1878
|
+
<dd>
|
|
1879
|
+
|
|
1880
|
+
<dl>
|
|
1881
|
+
<dd>
|
|
1882
|
+
|
|
1883
|
+
**request:** `AthenaIntelligence.StartComputerComputerRequest`
|
|
1884
|
+
|
|
1885
|
+
</dd>
|
|
1886
|
+
</dl>
|
|
1887
|
+
|
|
1888
|
+
<dl>
|
|
1889
|
+
<dd>
|
|
1890
|
+
|
|
1891
|
+
**requestOptions:** `ComputerClient.RequestOptions`
|
|
1892
|
+
|
|
1893
|
+
</dd>
|
|
1894
|
+
</dl>
|
|
1895
|
+
</dd>
|
|
1896
|
+
</dl>
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
</dd>
|
|
1900
|
+
</dl>
|
|
1901
|
+
</details>
|
|
1902
|
+
|
|
1903
|
+
<details><summary><code>client.computer.<a href="/src/api/resources/computer/client/Client.ts">stopComputer</a>({ ...params }) -> AthenaIntelligence.ComputerLifecycleResponseOut</code></summary>
|
|
1904
|
+
<dl>
|
|
1905
|
+
<dd>
|
|
1906
|
+
|
|
1907
|
+
#### 📝 Description
|
|
1908
|
+
|
|
1909
|
+
<dl>
|
|
1910
|
+
<dd>
|
|
1911
|
+
|
|
1912
|
+
<dl>
|
|
1913
|
+
<dd>
|
|
1914
|
+
|
|
1915
|
+
Stop (suspend) a running computer's runtime — the same operation as the Stop button in Athena. The computer's files persist and it can be started again with `start_computer`. Returns 409 when the provider does not support lifecycle operations or when the stop was refused because the workspace could not be saved (the computer is left running; retry).
|
|
1916
|
+
</dd>
|
|
1917
|
+
</dl>
|
|
1918
|
+
</dd>
|
|
1919
|
+
</dl>
|
|
1920
|
+
|
|
1921
|
+
#### 🔌 Usage
|
|
1922
|
+
|
|
1923
|
+
<dl>
|
|
1924
|
+
<dd>
|
|
1925
|
+
|
|
1926
|
+
<dl>
|
|
1927
|
+
<dd>
|
|
1928
|
+
|
|
1929
|
+
```typescript
|
|
1930
|
+
await client.computer.stopComputer({
|
|
1931
|
+
asset_id: "asset_id"
|
|
1932
|
+
});
|
|
1933
|
+
|
|
1934
|
+
```
|
|
1935
|
+
</dd>
|
|
1936
|
+
</dl>
|
|
1937
|
+
</dd>
|
|
1938
|
+
</dl>
|
|
1939
|
+
|
|
1940
|
+
#### ⚙️ Parameters
|
|
1941
|
+
|
|
1942
|
+
<dl>
|
|
1943
|
+
<dd>
|
|
1944
|
+
|
|
1945
|
+
<dl>
|
|
1946
|
+
<dd>
|
|
1947
|
+
|
|
1948
|
+
**request:** `AthenaIntelligence.StopComputerComputerRequest`
|
|
1949
|
+
|
|
1950
|
+
</dd>
|
|
1951
|
+
</dl>
|
|
1952
|
+
|
|
1953
|
+
<dl>
|
|
1954
|
+
<dd>
|
|
1955
|
+
|
|
1956
|
+
**requestOptions:** `ComputerClient.RequestOptions`
|
|
1957
|
+
|
|
1958
|
+
</dd>
|
|
1959
|
+
</dl>
|
|
1960
|
+
</dd>
|
|
1961
|
+
</dl>
|
|
1962
|
+
|
|
1963
|
+
|
|
1769
1964
|
</dd>
|
|
1770
1965
|
</dl>
|
|
1771
1966
|
</details>
|
|
@@ -2464,6 +2659,192 @@ await client.users.meSources();
|
|
|
2464
2659
|
</dl>
|
|
2465
2660
|
|
|
2466
2661
|
|
|
2662
|
+
</dd>
|
|
2663
|
+
</dl>
|
|
2664
|
+
</details>
|
|
2665
|
+
|
|
2666
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">listSshKeys</a>() -> AthenaIntelligence.SshKeyListResponseOut</code></summary>
|
|
2667
|
+
<dl>
|
|
2668
|
+
<dd>
|
|
2669
|
+
|
|
2670
|
+
#### 📝 Description
|
|
2671
|
+
|
|
2672
|
+
<dl>
|
|
2673
|
+
<dd>
|
|
2674
|
+
|
|
2675
|
+
<dl>
|
|
2676
|
+
<dd>
|
|
2677
|
+
|
|
2678
|
+
List the SSH public keys registered on the caller's Athena account. A registered key authenticates `ssh <computer_asset_id>@<gateway>` to every computer the caller can edit; keys are not tied to a workspace.
|
|
2679
|
+
</dd>
|
|
2680
|
+
</dl>
|
|
2681
|
+
</dd>
|
|
2682
|
+
</dl>
|
|
2683
|
+
|
|
2684
|
+
#### 🔌 Usage
|
|
2685
|
+
|
|
2686
|
+
<dl>
|
|
2687
|
+
<dd>
|
|
2688
|
+
|
|
2689
|
+
<dl>
|
|
2690
|
+
<dd>
|
|
2691
|
+
|
|
2692
|
+
```typescript
|
|
2693
|
+
await client.users.listSshKeys();
|
|
2694
|
+
|
|
2695
|
+
```
|
|
2696
|
+
</dd>
|
|
2697
|
+
</dl>
|
|
2698
|
+
</dd>
|
|
2699
|
+
</dl>
|
|
2700
|
+
|
|
2701
|
+
#### ⚙️ Parameters
|
|
2702
|
+
|
|
2703
|
+
<dl>
|
|
2704
|
+
<dd>
|
|
2705
|
+
|
|
2706
|
+
<dl>
|
|
2707
|
+
<dd>
|
|
2708
|
+
|
|
2709
|
+
**requestOptions:** `UsersClient.RequestOptions`
|
|
2710
|
+
|
|
2711
|
+
</dd>
|
|
2712
|
+
</dl>
|
|
2713
|
+
</dd>
|
|
2714
|
+
</dl>
|
|
2715
|
+
|
|
2716
|
+
|
|
2717
|
+
</dd>
|
|
2718
|
+
</dl>
|
|
2719
|
+
</details>
|
|
2720
|
+
|
|
2721
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">addSshKey</a>({ ...params }) -> AthenaIntelligence.SshKeyOut</code></summary>
|
|
2722
|
+
<dl>
|
|
2723
|
+
<dd>
|
|
2724
|
+
|
|
2725
|
+
#### 📝 Description
|
|
2726
|
+
|
|
2727
|
+
<dl>
|
|
2728
|
+
<dd>
|
|
2729
|
+
|
|
2730
|
+
<dl>
|
|
2731
|
+
<dd>
|
|
2732
|
+
|
|
2733
|
+
Register an SSH public key (the contents of an OpenSSH `.pub` file) on the caller's account. Returns 400 for a malformed or unsupported key, 409 when the key is already registered or the caller has reached the per-account limit.
|
|
2734
|
+
</dd>
|
|
2735
|
+
</dl>
|
|
2736
|
+
</dd>
|
|
2737
|
+
</dl>
|
|
2738
|
+
|
|
2739
|
+
#### 🔌 Usage
|
|
2740
|
+
|
|
2741
|
+
<dl>
|
|
2742
|
+
<dd>
|
|
2743
|
+
|
|
2744
|
+
<dl>
|
|
2745
|
+
<dd>
|
|
2746
|
+
|
|
2747
|
+
```typescript
|
|
2748
|
+
await client.users.addSshKey({
|
|
2749
|
+
label: "laptop",
|
|
2750
|
+
public_key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBZzuCu6wC9oVY2lVbVKdwpMElfCYiWTOIVQQBtq7HW9 me@laptop"
|
|
2751
|
+
});
|
|
2752
|
+
|
|
2753
|
+
```
|
|
2754
|
+
</dd>
|
|
2755
|
+
</dl>
|
|
2756
|
+
</dd>
|
|
2757
|
+
</dl>
|
|
2758
|
+
|
|
2759
|
+
#### ⚙️ Parameters
|
|
2760
|
+
|
|
2761
|
+
<dl>
|
|
2762
|
+
<dd>
|
|
2763
|
+
|
|
2764
|
+
<dl>
|
|
2765
|
+
<dd>
|
|
2766
|
+
|
|
2767
|
+
**request:** `AthenaIntelligence.AddSshKeyRequestIn`
|
|
2768
|
+
|
|
2769
|
+
</dd>
|
|
2770
|
+
</dl>
|
|
2771
|
+
|
|
2772
|
+
<dl>
|
|
2773
|
+
<dd>
|
|
2774
|
+
|
|
2775
|
+
**requestOptions:** `UsersClient.RequestOptions`
|
|
2776
|
+
|
|
2777
|
+
</dd>
|
|
2778
|
+
</dl>
|
|
2779
|
+
</dd>
|
|
2780
|
+
</dl>
|
|
2781
|
+
|
|
2782
|
+
|
|
2783
|
+
</dd>
|
|
2784
|
+
</dl>
|
|
2785
|
+
</details>
|
|
2786
|
+
|
|
2787
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">deleteSshKey</a>({ ...params }) -> AthenaIntelligence.DeleteSshKeyResponseOut</code></summary>
|
|
2788
|
+
<dl>
|
|
2789
|
+
<dd>
|
|
2790
|
+
|
|
2791
|
+
#### 📝 Description
|
|
2792
|
+
|
|
2793
|
+
<dl>
|
|
2794
|
+
<dd>
|
|
2795
|
+
|
|
2796
|
+
<dl>
|
|
2797
|
+
<dd>
|
|
2798
|
+
|
|
2799
|
+
Delete an SSH public key from the caller's account. SSH sessions authenticated with the key are closed by the gateway within a minute. Returns 404 for a key the caller does not own.
|
|
2800
|
+
</dd>
|
|
2801
|
+
</dl>
|
|
2802
|
+
</dd>
|
|
2803
|
+
</dl>
|
|
2804
|
+
|
|
2805
|
+
#### 🔌 Usage
|
|
2806
|
+
|
|
2807
|
+
<dl>
|
|
2808
|
+
<dd>
|
|
2809
|
+
|
|
2810
|
+
<dl>
|
|
2811
|
+
<dd>
|
|
2812
|
+
|
|
2813
|
+
```typescript
|
|
2814
|
+
await client.users.deleteSshKey({
|
|
2815
|
+
key_id: "key_id"
|
|
2816
|
+
});
|
|
2817
|
+
|
|
2818
|
+
```
|
|
2819
|
+
</dd>
|
|
2820
|
+
</dl>
|
|
2821
|
+
</dd>
|
|
2822
|
+
</dl>
|
|
2823
|
+
|
|
2824
|
+
#### ⚙️ Parameters
|
|
2825
|
+
|
|
2826
|
+
<dl>
|
|
2827
|
+
<dd>
|
|
2828
|
+
|
|
2829
|
+
<dl>
|
|
2830
|
+
<dd>
|
|
2831
|
+
|
|
2832
|
+
**request:** `AthenaIntelligence.DeleteSshKeyUsersRequest`
|
|
2833
|
+
|
|
2834
|
+
</dd>
|
|
2835
|
+
</dl>
|
|
2836
|
+
|
|
2837
|
+
<dl>
|
|
2838
|
+
<dd>
|
|
2839
|
+
|
|
2840
|
+
**requestOptions:** `UsersClient.RequestOptions`
|
|
2841
|
+
|
|
2842
|
+
</dd>
|
|
2843
|
+
</dl>
|
|
2844
|
+
</dd>
|
|
2845
|
+
</dl>
|
|
2846
|
+
|
|
2847
|
+
|
|
2467
2848
|
</dd>
|
|
2468
2849
|
</dl>
|
|
2469
2850
|
</details>
|