hanzoai 8.5.718 → 8.5.719
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/api/agent-api.d.ts +8 -8
- package/dist/api/agent-api.js +8 -8
- package/dist/api/share-api.d.ts +46 -16
- package/dist/api/share-api.js +75 -16
- package/dist/esm/api/agent-api.d.ts +8 -8
- package/dist/esm/api/agent-api.js +8 -8
- package/dist/esm/api/share-api.d.ts +46 -16
- package/dist/esm/api/share-api.js +75 -16
- package/dist/esm/models/agent-target-list.d.ts +1 -1
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/esm/models/share-enable-resp.d.ts +1 -1
- package/dist/esm/models/share-rotated.d.ts +30 -0
- package/dist/esm/models/share-rotated.js +14 -0
- package/dist/models/agent-target-list.d.ts +1 -1
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/share-enable-resp.d.ts +1 -1
- package/dist/models/share-rotated.d.ts +30 -0
- package/dist/models/share-rotated.js +15 -0
- package/package.json +1 -1
- package/src/api/agent-api.ts +8 -8
- package/src/api/share-api.ts +84 -16
- package/src/models/agent-target-list.ts +1 -1
- package/src/models/index.ts +1 -0
- package/src/models/share-enable-resp.ts +1 -1
- package/src/models/share-rotated.ts +36 -0
package/dist/api/agent-api.d.ts
CHANGED
|
@@ -286,7 +286,7 @@ export declare const AgentApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
286
286
|
*/
|
|
287
287
|
getAgentSessions: (root?: string, parent?: string, status?: string, project?: string, room?: string, kind?: string, limit?: number, after?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
288
288
|
/**
|
|
289
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
289
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
290
290
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
291
291
|
* @param {string} id ID is the session to act on, from the path.
|
|
292
292
|
* @param {*} [options] Override http request option.
|
|
@@ -326,7 +326,7 @@ export declare const AgentApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
326
326
|
*/
|
|
327
327
|
getAgentSessionsStream: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
328
328
|
/**
|
|
329
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
329
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
330
330
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
331
331
|
* @param {*} [options] Override http request option.
|
|
332
332
|
* @throws {RequiredError}
|
|
@@ -780,7 +780,7 @@ export declare const AgentApiFp: (configuration?: Configuration) => {
|
|
|
780
780
|
*/
|
|
781
781
|
getAgentSessions(root?: string, parent?: string, status?: string, project?: string, room?: string, kind?: string, limit?: number, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgentSessionList>>;
|
|
782
782
|
/**
|
|
783
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
783
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
784
784
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
785
785
|
* @param {string} id ID is the session to act on, from the path.
|
|
786
786
|
* @param {*} [options] Override http request option.
|
|
@@ -820,7 +820,7 @@ export declare const AgentApiFp: (configuration?: Configuration) => {
|
|
|
820
820
|
*/
|
|
821
821
|
getAgentSessionsStream(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
822
822
|
/**
|
|
823
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
823
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
824
824
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
825
825
|
* @param {*} [options] Override http request option.
|
|
826
826
|
* @throws {RequiredError}
|
|
@@ -1258,7 +1258,7 @@ export declare const AgentApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1258
1258
|
*/
|
|
1259
1259
|
getAgentSessions(requestParameters?: AgentApiGetAgentSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AgentSessionList>;
|
|
1260
1260
|
/**
|
|
1261
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
1261
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
1262
1262
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
1263
1263
|
* @param {AgentApiGetAgentSessionsByIdRequest} requestParameters Request parameters.
|
|
1264
1264
|
* @param {*} [options] Override http request option.
|
|
@@ -1297,7 +1297,7 @@ export declare const AgentApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1297
1297
|
*/
|
|
1298
1298
|
getAgentSessionsStream(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1299
1299
|
/**
|
|
1300
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
1300
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
1301
1301
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
1302
1302
|
* @param {*} [options] Override http request option.
|
|
1303
1303
|
* @throws {RequiredError}
|
|
@@ -2532,7 +2532,7 @@ export declare class AgentApi extends BaseAPI {
|
|
|
2532
2532
|
*/
|
|
2533
2533
|
getAgentSessions(requestParameters?: AgentApiGetAgentSessionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<AgentSessionList, any, {}>>;
|
|
2534
2534
|
/**
|
|
2535
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
2535
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
2536
2536
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
2537
2537
|
* @param {AgentApiGetAgentSessionsByIdRequest} requestParameters Request parameters.
|
|
2538
2538
|
* @param {*} [options] Override http request option.
|
|
@@ -2576,7 +2576,7 @@ export declare class AgentApi extends BaseAPI {
|
|
|
2576
2576
|
*/
|
|
2577
2577
|
getAgentSessionsStream(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
|
|
2578
2578
|
/**
|
|
2579
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
2579
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
2580
2580
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
2581
2581
|
* @param {*} [options] Override http request option.
|
|
2582
2582
|
* @throws {RequiredError}
|
package/dist/api/agent-api.js
CHANGED
|
@@ -934,7 +934,7 @@ const AgentApiAxiosParamCreator = function (configuration) {
|
|
|
934
934
|
};
|
|
935
935
|
},
|
|
936
936
|
/**
|
|
937
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
937
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
938
938
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
939
939
|
* @param {string} id ID is the session to act on, from the path.
|
|
940
940
|
* @param {*} [options] Override http request option.
|
|
@@ -1094,7 +1094,7 @@ const AgentApiAxiosParamCreator = function (configuration) {
|
|
|
1094
1094
|
};
|
|
1095
1095
|
},
|
|
1096
1096
|
/**
|
|
1097
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
1097
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
1098
1098
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
1099
1099
|
* @param {*} [options] Override http request option.
|
|
1100
1100
|
* @throws {RequiredError}
|
|
@@ -2367,7 +2367,7 @@ const AgentApiFp = function (configuration) {
|
|
|
2367
2367
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2368
2368
|
},
|
|
2369
2369
|
/**
|
|
2370
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
2370
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
2371
2371
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
2372
2372
|
* @param {string} id ID is the session to act on, from the path.
|
|
2373
2373
|
* @param {*} [options] Override http request option.
|
|
@@ -2432,7 +2432,7 @@ const AgentApiFp = function (configuration) {
|
|
|
2432
2432
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2433
2433
|
},
|
|
2434
2434
|
/**
|
|
2435
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
2435
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
2436
2436
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
2437
2437
|
* @param {*} [options] Override http request option.
|
|
2438
2438
|
* @throws {RequiredError}
|
|
@@ -3063,7 +3063,7 @@ const AgentApiFactory = function (configuration, basePath, axios) {
|
|
|
3063
3063
|
return localVarFp.getAgentSessions(requestParameters.root, requestParameters.parent, requestParameters.status, requestParameters.project, requestParameters.room, requestParameters.kind, requestParameters.limit, requestParameters.after, options).then((request) => request(axios, basePath));
|
|
3064
3064
|
},
|
|
3065
3065
|
/**
|
|
3066
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
3066
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
3067
3067
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
3068
3068
|
* @param {AgentApiGetAgentSessionsByIdRequest} requestParameters Request parameters.
|
|
3069
3069
|
* @param {*} [options] Override http request option.
|
|
@@ -3112,7 +3112,7 @@ const AgentApiFactory = function (configuration, basePath, axios) {
|
|
|
3112
3112
|
return localVarFp.getAgentSessionsStream(options).then((request) => request(axios, basePath));
|
|
3113
3113
|
},
|
|
3114
3114
|
/**
|
|
3115
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
3115
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
3116
3116
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
3117
3117
|
* @param {*} [options] Override http request option.
|
|
3118
3118
|
* @throws {RequiredError}
|
|
@@ -3678,7 +3678,7 @@ class AgentApi extends base_1.BaseAPI {
|
|
|
3678
3678
|
return (0, exports.AgentApiFp)(this.configuration).getAgentSessions(requestParameters.root, requestParameters.parent, requestParameters.status, requestParameters.project, requestParameters.room, requestParameters.kind, requestParameters.limit, requestParameters.after, options).then((request) => request(this.axios, this.basePath));
|
|
3679
3679
|
}
|
|
3680
3680
|
/**
|
|
3681
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
3681
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
3682
3682
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
3683
3683
|
* @param {AgentApiGetAgentSessionsByIdRequest} requestParameters Request parameters.
|
|
3684
3684
|
* @param {*} [options] Override http request option.
|
|
@@ -3732,7 +3732,7 @@ class AgentApi extends base_1.BaseAPI {
|
|
|
3732
3732
|
return (0, exports.AgentApiFp)(this.configuration).getAgentSessionsStream(options).then((request) => request(this.axios, this.basePath));
|
|
3733
3733
|
}
|
|
3734
3734
|
/**
|
|
3735
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
3735
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
3736
3736
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
3737
3737
|
* @param {*} [options] Override http request option.
|
|
3738
3738
|
* @throws {RequiredError}
|
package/dist/api/share-api.d.ts
CHANGED
|
@@ -14,6 +14,7 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
15
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
16
|
import type { ShareEnableResp } from '../models';
|
|
17
|
+
import type { ShareRotated } from '../models';
|
|
17
18
|
import type { ShareSharesOut } from '../models';
|
|
18
19
|
/**
|
|
19
20
|
* ShareApi - axios parameter creator
|
|
@@ -21,19 +22,26 @@ import type { ShareSharesOut } from '../models';
|
|
|
21
22
|
*/
|
|
22
23
|
export declare const ShareApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
24
|
/**
|
|
24
|
-
* Returns the tunnel shares the caller\'s
|
|
25
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
25
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
26
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
26
27
|
* @param {*} [options] Override http request option.
|
|
27
28
|
* @throws {RequiredError}
|
|
28
29
|
*/
|
|
29
30
|
getShare: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
31
|
/**
|
|
31
|
-
* Provisions the caller
|
|
32
|
-
* @summary Provisions the caller
|
|
32
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
33
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
33
34
|
* @param {*} [options] Override http request option.
|
|
34
35
|
* @throws {RequiredError}
|
|
35
36
|
*/
|
|
36
37
|
postShareEnable: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
40
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
postShareRotate: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
45
|
};
|
|
38
46
|
/**
|
|
39
47
|
* ShareApi - functional programming interface
|
|
@@ -41,19 +49,26 @@ export declare const ShareApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
41
49
|
*/
|
|
42
50
|
export declare const ShareApiFp: (configuration?: Configuration) => {
|
|
43
51
|
/**
|
|
44
|
-
* Returns the tunnel shares the caller\'s
|
|
45
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
52
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
53
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
46
54
|
* @param {*} [options] Override http request option.
|
|
47
55
|
* @throws {RequiredError}
|
|
48
56
|
*/
|
|
49
57
|
getShare(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareSharesOut>>;
|
|
50
58
|
/**
|
|
51
|
-
* Provisions the caller
|
|
52
|
-
* @summary Provisions the caller
|
|
59
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
60
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
53
61
|
* @param {*} [options] Override http request option.
|
|
54
62
|
* @throws {RequiredError}
|
|
55
63
|
*/
|
|
56
64
|
postShareEnable(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareEnableResp>>;
|
|
65
|
+
/**
|
|
66
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
67
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
postShareRotate(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareRotated>>;
|
|
57
72
|
};
|
|
58
73
|
/**
|
|
59
74
|
* ShareApi - factory interface
|
|
@@ -61,19 +76,26 @@ export declare const ShareApiFp: (configuration?: Configuration) => {
|
|
|
61
76
|
*/
|
|
62
77
|
export declare const ShareApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
63
78
|
/**
|
|
64
|
-
* Returns the tunnel shares the caller\'s
|
|
65
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
79
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
80
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
66
81
|
* @param {*} [options] Override http request option.
|
|
67
82
|
* @throws {RequiredError}
|
|
68
83
|
*/
|
|
69
84
|
getShare(options?: RawAxiosRequestConfig): AxiosPromise<ShareSharesOut>;
|
|
70
85
|
/**
|
|
71
|
-
* Provisions the caller
|
|
72
|
-
* @summary Provisions the caller
|
|
86
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
87
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
73
88
|
* @param {*} [options] Override http request option.
|
|
74
89
|
* @throws {RequiredError}
|
|
75
90
|
*/
|
|
76
91
|
postShareEnable(options?: RawAxiosRequestConfig): AxiosPromise<ShareEnableResp>;
|
|
92
|
+
/**
|
|
93
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
94
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
postShareRotate(options?: RawAxiosRequestConfig): AxiosPromise<ShareRotated>;
|
|
77
99
|
};
|
|
78
100
|
/**
|
|
79
101
|
* ShareApi - object-oriented interface
|
|
@@ -83,19 +105,27 @@ export declare const ShareApiFactory: (configuration?: Configuration, basePath?:
|
|
|
83
105
|
*/
|
|
84
106
|
export declare class ShareApi extends BaseAPI {
|
|
85
107
|
/**
|
|
86
|
-
* Returns the tunnel shares the caller\'s
|
|
87
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
108
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
109
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
88
110
|
* @param {*} [options] Override http request option.
|
|
89
111
|
* @throws {RequiredError}
|
|
90
112
|
* @memberof ShareApi
|
|
91
113
|
*/
|
|
92
114
|
getShare(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShareSharesOut, any, {}>>;
|
|
93
115
|
/**
|
|
94
|
-
* Provisions the caller
|
|
95
|
-
* @summary Provisions the caller
|
|
116
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
117
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
96
118
|
* @param {*} [options] Override http request option.
|
|
97
119
|
* @throws {RequiredError}
|
|
98
120
|
* @memberof ShareApi
|
|
99
121
|
*/
|
|
100
122
|
postShareEnable(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShareEnableResp, any, {}>>;
|
|
123
|
+
/**
|
|
124
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
125
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
* @memberof ShareApi
|
|
129
|
+
*/
|
|
130
|
+
postShareRotate(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ShareRotated, any, {}>>;
|
|
101
131
|
}
|
package/dist/api/share-api.js
CHANGED
|
@@ -30,8 +30,8 @@ const base_1 = require("../base");
|
|
|
30
30
|
const ShareApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* Returns the tunnel shares the caller\'s
|
|
34
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
33
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
34
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
36
36
|
* @throws {RequiredError}
|
|
37
37
|
*/
|
|
@@ -58,8 +58,8 @@ const ShareApiAxiosParamCreator = function (configuration) {
|
|
|
58
58
|
};
|
|
59
59
|
},
|
|
60
60
|
/**
|
|
61
|
-
* Provisions the caller
|
|
62
|
-
* @summary Provisions the caller
|
|
61
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
62
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
@@ -85,6 +85,34 @@ const ShareApiAxiosParamCreator = function (configuration) {
|
|
|
85
85
|
options: localVarRequestOptions,
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
|
+
/**
|
|
89
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
90
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
postShareRotate: async (options = {}) => {
|
|
95
|
+
const localVarPath = `/v1/share/rotate`;
|
|
96
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
97
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
98
|
+
let baseOptions;
|
|
99
|
+
if (configuration) {
|
|
100
|
+
baseOptions = configuration.baseOptions;
|
|
101
|
+
}
|
|
102
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
103
|
+
const localVarHeaderParameter = {};
|
|
104
|
+
const localVarQueryParameter = {};
|
|
105
|
+
// authentication bearer required
|
|
106
|
+
// http bearer authentication required
|
|
107
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
108
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
109
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
110
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
111
|
+
return {
|
|
112
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
113
|
+
options: localVarRequestOptions,
|
|
114
|
+
};
|
|
115
|
+
},
|
|
88
116
|
};
|
|
89
117
|
};
|
|
90
118
|
exports.ShareApiAxiosParamCreator = ShareApiAxiosParamCreator;
|
|
@@ -96,8 +124,8 @@ const ShareApiFp = function (configuration) {
|
|
|
96
124
|
const localVarAxiosParamCreator = (0, exports.ShareApiAxiosParamCreator)(configuration);
|
|
97
125
|
return {
|
|
98
126
|
/**
|
|
99
|
-
* Returns the tunnel shares the caller\'s
|
|
100
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
127
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
128
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
101
129
|
* @param {*} [options] Override http request option.
|
|
102
130
|
* @throws {RequiredError}
|
|
103
131
|
*/
|
|
@@ -108,8 +136,8 @@ const ShareApiFp = function (configuration) {
|
|
|
108
136
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
109
137
|
},
|
|
110
138
|
/**
|
|
111
|
-
* Provisions the caller
|
|
112
|
-
* @summary Provisions the caller
|
|
139
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
140
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
113
141
|
* @param {*} [options] Override http request option.
|
|
114
142
|
* @throws {RequiredError}
|
|
115
143
|
*/
|
|
@@ -119,6 +147,18 @@ const ShareApiFp = function (configuration) {
|
|
|
119
147
|
const localVarOperationServerBasePath = base_1.operationServerMap['ShareApi.postShareEnable']?.[localVarOperationServerIndex]?.url;
|
|
120
148
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
121
149
|
},
|
|
150
|
+
/**
|
|
151
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
152
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
async postShareRotate(options) {
|
|
157
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postShareRotate(options);
|
|
158
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
159
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['ShareApi.postShareRotate']?.[localVarOperationServerIndex]?.url;
|
|
160
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
161
|
+
},
|
|
122
162
|
};
|
|
123
163
|
};
|
|
124
164
|
exports.ShareApiFp = ShareApiFp;
|
|
@@ -130,8 +170,8 @@ const ShareApiFactory = function (configuration, basePath, axios) {
|
|
|
130
170
|
const localVarFp = (0, exports.ShareApiFp)(configuration);
|
|
131
171
|
return {
|
|
132
172
|
/**
|
|
133
|
-
* Returns the tunnel shares the caller\'s
|
|
134
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
173
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
174
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
135
175
|
* @param {*} [options] Override http request option.
|
|
136
176
|
* @throws {RequiredError}
|
|
137
177
|
*/
|
|
@@ -139,14 +179,23 @@ const ShareApiFactory = function (configuration, basePath, axios) {
|
|
|
139
179
|
return localVarFp.getShare(options).then((request) => request(axios, basePath));
|
|
140
180
|
},
|
|
141
181
|
/**
|
|
142
|
-
* Provisions the caller
|
|
143
|
-
* @summary Provisions the caller
|
|
182
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
183
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
144
184
|
* @param {*} [options] Override http request option.
|
|
145
185
|
* @throws {RequiredError}
|
|
146
186
|
*/
|
|
147
187
|
postShareEnable(options) {
|
|
148
188
|
return localVarFp.postShareEnable(options).then((request) => request(axios, basePath));
|
|
149
189
|
},
|
|
190
|
+
/**
|
|
191
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
192
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
postShareRotate(options) {
|
|
197
|
+
return localVarFp.postShareRotate(options).then((request) => request(axios, basePath));
|
|
198
|
+
},
|
|
150
199
|
};
|
|
151
200
|
};
|
|
152
201
|
exports.ShareApiFactory = ShareApiFactory;
|
|
@@ -158,8 +207,8 @@ exports.ShareApiFactory = ShareApiFactory;
|
|
|
158
207
|
*/
|
|
159
208
|
class ShareApi extends base_1.BaseAPI {
|
|
160
209
|
/**
|
|
161
|
-
* Returns the tunnel shares the caller\'s
|
|
162
|
-
* @summary Returns the tunnel shares the caller\'s
|
|
210
|
+
* Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled. It is a READ and it degrades honestly: an unconfigured deployment, an org that has not provisioned yet, and an unreachable controller all answer an EMPTY list at 200 rather than an error, so the console never error-toasts on load.
|
|
211
|
+
* @summary Returns the tunnel shares the caller\'s account currently has open — their org\'s, or in a held org their own — across every environment it has enabled.
|
|
163
212
|
* @param {*} [options] Override http request option.
|
|
164
213
|
* @throws {RequiredError}
|
|
165
214
|
* @memberof ShareApi
|
|
@@ -168,8 +217,8 @@ class ShareApi extends base_1.BaseAPI {
|
|
|
168
217
|
return (0, exports.ShareApiFp)(this.configuration).getShare(options).then((request) => request(this.axios, this.basePath));
|
|
169
218
|
}
|
|
170
219
|
/**
|
|
171
|
-
* Provisions the caller
|
|
172
|
-
* @summary Provisions the caller
|
|
220
|
+
* Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel. It is idempotent: the account is keyed deterministically off the VALIDATED org and, in a held org, the caller\'s attested subject, so a repeat call hands back the same account rather than creating a second one, and a caller can only ever provision their OWN. 503 when the deployment has no share controller configured; 502 when that controller is unreachable.
|
|
221
|
+
* @summary Provisions the caller\'s tunnel account — their org\'s, or in a held org, where every self-serve signup lands, their own — and returns the credential the `hanzo share` CLI needs to run a tunnel.
|
|
173
222
|
* @param {*} [options] Override http request option.
|
|
174
223
|
* @throws {RequiredError}
|
|
175
224
|
* @memberof ShareApi
|
|
@@ -177,5 +226,15 @@ class ShareApi extends base_1.BaseAPI {
|
|
|
177
226
|
postShareEnable(options) {
|
|
178
227
|
return (0, exports.ShareApiFp)(this.configuration).postShareEnable(options).then((request) => request(this.axios, this.basePath));
|
|
179
228
|
}
|
|
229
|
+
/**
|
|
230
|
+
* Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on. The account is kept: enable hands its holder the new credential. In a customer\'s org the account is the org\'s, which its members share, and an admin of the org or a SuperAdmin rotates it. In a held org each person\'s account is their own, and they rotate it — every account they hold, the one an API key of theirs was handed before included, so none stays live. An admin of the org or a SuperAdmin then rotates the org\'s own account, which no call there hands out, whether or not they hold an account of their own; when that one cannot be rotated, `pending` says so and their own are rotated still. An account never provisioned has nothing to rotate and counts 0. 503 when the deployment has no share controller configured; 502 when that controller is unreachable, or holds the caller\'s account under a credential this deployment does not derive — out of a rotation\'s reach, so it is refused rather than reported done.
|
|
231
|
+
* @summary Replaces the credential of a tunnel account and ends every environment enabled with it, shares and all, so a credential handed out before — to a member who has left, or to anyone who read it — opens nothing from now on.
|
|
232
|
+
* @param {*} [options] Override http request option.
|
|
233
|
+
* @throws {RequiredError}
|
|
234
|
+
* @memberof ShareApi
|
|
235
|
+
*/
|
|
236
|
+
postShareRotate(options) {
|
|
237
|
+
return (0, exports.ShareApiFp)(this.configuration).postShareRotate(options).then((request) => request(this.axios, this.basePath));
|
|
238
|
+
}
|
|
180
239
|
}
|
|
181
240
|
exports.ShareApi = ShareApi;
|
|
@@ -285,7 +285,7 @@ export declare const AgentApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
285
285
|
*/
|
|
286
286
|
getAgentSessions: (root?: string, parent?: string, status?: string, project?: string, room?: string, kind?: string, limit?: number, after?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
287
287
|
/**
|
|
288
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
288
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
289
289
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
290
290
|
* @param {string} id ID is the session to act on, from the path.
|
|
291
291
|
* @param {*} [options] Override http request option.
|
|
@@ -325,7 +325,7 @@ export declare const AgentApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
325
325
|
*/
|
|
326
326
|
getAgentSessionsStream: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
327
327
|
/**
|
|
328
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
328
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
329
329
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
330
330
|
* @param {*} [options] Override http request option.
|
|
331
331
|
* @throws {RequiredError}
|
|
@@ -779,7 +779,7 @@ export declare const AgentApiFp: (configuration?: Configuration) => {
|
|
|
779
779
|
*/
|
|
780
780
|
getAgentSessions(root?: string, parent?: string, status?: string, project?: string, room?: string, kind?: string, limit?: number, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgentSessionList>>;
|
|
781
781
|
/**
|
|
782
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
782
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
783
783
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
784
784
|
* @param {string} id ID is the session to act on, from the path.
|
|
785
785
|
* @param {*} [options] Override http request option.
|
|
@@ -819,7 +819,7 @@ export declare const AgentApiFp: (configuration?: Configuration) => {
|
|
|
819
819
|
*/
|
|
820
820
|
getAgentSessionsStream(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
821
821
|
/**
|
|
822
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
822
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
823
823
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
824
824
|
* @param {*} [options] Override http request option.
|
|
825
825
|
* @throws {RequiredError}
|
|
@@ -1257,7 +1257,7 @@ export declare const AgentApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1257
1257
|
*/
|
|
1258
1258
|
getAgentSessions(requestParameters?: AgentApiGetAgentSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AgentSessionList>;
|
|
1259
1259
|
/**
|
|
1260
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
1260
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
1261
1261
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
1262
1262
|
* @param {AgentApiGetAgentSessionsByIdRequest} requestParameters Request parameters.
|
|
1263
1263
|
* @param {*} [options] Override http request option.
|
|
@@ -1296,7 +1296,7 @@ export declare const AgentApiFactory: (configuration?: Configuration, basePath?:
|
|
|
1296
1296
|
*/
|
|
1297
1297
|
getAgentSessionsStream(options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1298
1298
|
/**
|
|
1299
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
1299
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
1300
1300
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
1301
1301
|
* @param {*} [options] Override http request option.
|
|
1302
1302
|
* @throws {RequiredError}
|
|
@@ -2531,7 +2531,7 @@ export declare class AgentApi extends BaseAPI {
|
|
|
2531
2531
|
*/
|
|
2532
2532
|
getAgentSessions(requestParameters?: AgentApiGetAgentSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgentSessionList, any, {}>>;
|
|
2533
2533
|
/**
|
|
2534
|
-
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org.
|
|
2534
|
+
* Returns one session with its direct child sessions and its 50 most recent events, oldest of those first. The children are those the caller may see, by the rule the session itself is read by: a member\'s own, and every one for an admin of the org. In a held org, where self-serve signups land beside the platform\'s staff, a session is its person\'s alone.
|
|
2535
2535
|
* @summary Returns one session with its direct child sessions and its 50 most recent events, oldest of those first.
|
|
2536
2536
|
* @param {AgentApiGetAgentSessionsByIdRequest} requestParameters Request parameters.
|
|
2537
2537
|
* @param {*} [options] Override http request option.
|
|
@@ -2575,7 +2575,7 @@ export declare class AgentApi extends BaseAPI {
|
|
|
2575
2575
|
*/
|
|
2576
2576
|
getAgentSessionsStream(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
2577
2577
|
/**
|
|
2578
|
-
* Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
2578
|
+
* Returns every machine registered to the caller\'s org, newest first, each with its live session load. In a held org, where self-serve signups land beside the platform\'s staff, it is only the caller\'s own.
|
|
2579
2579
|
* @summary Returns every machine registered to the caller\'s org, newest first, each with its live session load.
|
|
2580
2580
|
* @param {*} [options] Override http request option.
|
|
2581
2581
|
* @throws {RequiredError}
|