@spaciv/sdk 0.1.0 → 0.1.2
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/.openapi-generator/FILES +26 -0
- package/README.md +2 -2
- package/dist/apis/AccountsApi.d.ts +24 -24
- package/dist/apis/AccountsApi.js +12 -12
- package/dist/apis/AssistantApi.d.ts +28 -1
- package/dist/apis/AssistantApi.js +39 -0
- package/dist/apis/AuditLogApi.d.ts +1 -1
- package/dist/apis/AuthenticationApi.d.ts +8 -8
- package/dist/apis/AuthenticationApi.js +4 -4
- package/dist/apis/ScriptsApi.d.ts +383 -0
- package/dist/apis/ScriptsApi.js +559 -0
- package/dist/apis/UsersApi.d.ts +4 -4
- package/dist/apis/UsersApi.js +2 -2
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/AccountsApi.d.ts +24 -24
- package/dist/esm/apis/AccountsApi.js +12 -12
- package/dist/esm/apis/AssistantApi.d.ts +28 -1
- package/dist/esm/apis/AssistantApi.js +40 -1
- package/dist/esm/apis/AuditLogApi.d.ts +1 -1
- package/dist/esm/apis/AuthenticationApi.d.ts +8 -8
- package/dist/esm/apis/AuthenticationApi.js +4 -4
- package/dist/esm/apis/ScriptsApi.d.ts +383 -0
- package/dist/esm/apis/ScriptsApi.js +555 -0
- package/dist/esm/apis/UsersApi.d.ts +4 -4
- package/dist/esm/apis/UsersApi.js +2 -2
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/APIKey.d.ts +6 -0
- package/dist/esm/models/APIKey.js +2 -0
- package/dist/esm/models/AssistantTranscriptBody.d.ts +45 -0
- package/dist/esm/models/AssistantTranscriptBody.js +52 -0
- package/dist/esm/models/AssistantTranscriptMessage.d.ts +98 -0
- package/dist/esm/models/AssistantTranscriptMessage.js +90 -0
- package/dist/esm/models/AssistantTranscriptToolCall.d.ts +44 -0
- package/dist/esm/models/AssistantTranscriptToolCall.js +51 -0
- package/dist/esm/models/ScriptAuditEntry.d.ts +67 -0
- package/dist/esm/models/ScriptAuditEntry.js +63 -0
- package/dist/esm/models/ScriptAuditResBody.d.ts +39 -0
- package/dist/esm/models/ScriptAuditResBody.js +46 -0
- package/dist/esm/models/ScriptDetail.d.ts +161 -0
- package/dist/esm/models/ScriptDetail.js +122 -0
- package/dist/esm/models/ScriptExport.d.ts +174 -0
- package/dist/esm/models/ScriptExport.js +129 -0
- package/dist/esm/models/ScriptExportResBody.d.ts +39 -0
- package/dist/esm/models/ScriptExportResBody.js +48 -0
- package/dist/esm/models/ScriptExportRun.d.ts +92 -0
- package/dist/esm/models/ScriptExportRun.js +73 -0
- package/dist/esm/models/ScriptKey.d.ts +64 -0
- package/dist/esm/models/ScriptKey.js +58 -0
- package/dist/esm/models/ScriptListResBody.d.ts +33 -0
- package/dist/esm/models/ScriptListResBody.js +44 -0
- package/dist/esm/models/ScriptLogLine.d.ts +38 -0
- package/dist/esm/models/ScriptLogLine.js +47 -0
- package/dist/esm/models/ScriptPatchReqBody.d.ts +98 -0
- package/dist/esm/models/ScriptPatchReqBody.js +70 -0
- package/dist/esm/models/ScriptPostReqBody.d.ts +113 -0
- package/dist/esm/models/ScriptPostReqBody.js +82 -0
- package/dist/esm/models/ScriptRun.d.ts +86 -0
- package/dist/esm/models/ScriptRun.js +69 -0
- package/dist/esm/models/ScriptRunLogsResBody.d.ts +39 -0
- package/dist/esm/models/ScriptRunLogsResBody.js +48 -0
- package/dist/esm/models/ScriptRunsResBody.d.ts +39 -0
- package/dist/esm/models/ScriptRunsResBody.js +46 -0
- package/dist/esm/models/ScriptRuntime.d.ts +62 -0
- package/dist/esm/models/ScriptRuntime.js +51 -0
- package/dist/esm/models/ScriptSchedule.d.ts +38 -0
- package/dist/esm/models/ScriptSchedule.js +43 -0
- package/dist/esm/models/ScriptSchedulePreviewReqBody.d.ts +44 -0
- package/dist/esm/models/ScriptSchedulePreviewReqBody.js +45 -0
- package/dist/esm/models/ScriptSchedulePreviewResBody.d.ts +44 -0
- package/dist/esm/models/ScriptSchedulePreviewResBody.js +49 -0
- package/dist/esm/models/ScriptSecretsReqBody.d.ts +40 -0
- package/dist/esm/models/ScriptSecretsReqBody.js +43 -0
- package/dist/esm/models/ScriptSecretsResBody.d.ts +134 -0
- package/dist/esm/models/ScriptSecretsResBody.js +111 -0
- package/dist/esm/models/ScriptSummary.d.ts +128 -0
- package/dist/esm/models/ScriptSummary.js +107 -0
- package/dist/esm/models/ScriptWebhookResBody.d.ts +32 -0
- package/dist/esm/models/ScriptWebhookResBody.js +43 -0
- package/dist/esm/models/index.d.ts +25 -0
- package/dist/esm/models/index.js +25 -0
- package/dist/models/APIKey.d.ts +6 -0
- package/dist/models/APIKey.js +2 -0
- package/dist/models/AssistantTranscriptBody.d.ts +45 -0
- package/dist/models/AssistantTranscriptBody.js +59 -0
- package/dist/models/AssistantTranscriptMessage.d.ts +98 -0
- package/dist/models/AssistantTranscriptMessage.js +98 -0
- package/dist/models/AssistantTranscriptToolCall.d.ts +44 -0
- package/dist/models/AssistantTranscriptToolCall.js +58 -0
- package/dist/models/ScriptAuditEntry.d.ts +67 -0
- package/dist/models/ScriptAuditEntry.js +71 -0
- package/dist/models/ScriptAuditResBody.d.ts +39 -0
- package/dist/models/ScriptAuditResBody.js +53 -0
- package/dist/models/ScriptDetail.d.ts +161 -0
- package/dist/models/ScriptDetail.js +130 -0
- package/dist/models/ScriptExport.d.ts +174 -0
- package/dist/models/ScriptExport.js +137 -0
- package/dist/models/ScriptExportResBody.d.ts +39 -0
- package/dist/models/ScriptExportResBody.js +55 -0
- package/dist/models/ScriptExportRun.d.ts +92 -0
- package/dist/models/ScriptExportRun.js +80 -0
- package/dist/models/ScriptKey.d.ts +64 -0
- package/dist/models/ScriptKey.js +66 -0
- package/dist/models/ScriptListResBody.d.ts +33 -0
- package/dist/models/ScriptListResBody.js +51 -0
- package/dist/models/ScriptLogLine.d.ts +38 -0
- package/dist/models/ScriptLogLine.js +54 -0
- package/dist/models/ScriptPatchReqBody.d.ts +98 -0
- package/dist/models/ScriptPatchReqBody.js +78 -0
- package/dist/models/ScriptPostReqBody.d.ts +113 -0
- package/dist/models/ScriptPostReqBody.js +90 -0
- package/dist/models/ScriptRun.d.ts +86 -0
- package/dist/models/ScriptRun.js +76 -0
- package/dist/models/ScriptRunLogsResBody.d.ts +39 -0
- package/dist/models/ScriptRunLogsResBody.js +55 -0
- package/dist/models/ScriptRunsResBody.d.ts +39 -0
- package/dist/models/ScriptRunsResBody.js +53 -0
- package/dist/models/ScriptRuntime.d.ts +62 -0
- package/dist/models/ScriptRuntime.js +58 -0
- package/dist/models/ScriptSchedule.d.ts +38 -0
- package/dist/models/ScriptSchedule.js +50 -0
- package/dist/models/ScriptSchedulePreviewReqBody.d.ts +44 -0
- package/dist/models/ScriptSchedulePreviewReqBody.js +52 -0
- package/dist/models/ScriptSchedulePreviewResBody.d.ts +44 -0
- package/dist/models/ScriptSchedulePreviewResBody.js +56 -0
- package/dist/models/ScriptSecretsReqBody.d.ts +40 -0
- package/dist/models/ScriptSecretsReqBody.js +50 -0
- package/dist/models/ScriptSecretsResBody.d.ts +134 -0
- package/dist/models/ScriptSecretsResBody.js +119 -0
- package/dist/models/ScriptSummary.d.ts +128 -0
- package/dist/models/ScriptSummary.js +115 -0
- package/dist/models/ScriptWebhookResBody.d.ts +32 -0
- package/dist/models/ScriptWebhookResBody.js +50 -0
- package/dist/models/index.d.ts +25 -0
- package/dist/models/index.js +25 -0
- package/package.json +1 -1
- package/src/apis/AccountsApi.ts +24 -24
- package/src/apis/AssistantApi.ts +70 -0
- package/src/apis/AuditLogApi.ts +1 -1
- package/src/apis/AuthenticationApi.ts +8 -8
- package/src/apis/ScriptsApi.ts +984 -0
- package/src/apis/UsersApi.ts +4 -4
- package/src/apis/index.ts +1 -0
- package/src/models/APIKey.ts +8 -0
- package/src/models/AssistantTranscriptBody.ts +92 -0
- package/src/models/AssistantTranscriptMessage.ts +175 -0
- package/src/models/AssistantTranscriptToolCall.ts +84 -0
- package/src/models/ScriptAuditEntry.ts +112 -0
- package/src/models/ScriptAuditResBody.ts +82 -0
- package/src/models/ScriptDetail.ts +265 -0
- package/src/models/ScriptExport.ts +289 -0
- package/src/models/ScriptExportResBody.ts +83 -0
- package/src/models/ScriptExportRun.ts +151 -0
- package/src/models/ScriptKey.ts +109 -0
- package/src/models/ScriptListResBody.ts +74 -0
- package/src/models/ScriptLogLine.ts +75 -0
- package/src/models/ScriptPatchReqBody.ts +158 -0
- package/src/models/ScriptPostReqBody.ts +176 -0
- package/src/models/ScriptRun.ts +142 -0
- package/src/models/ScriptRunLogsResBody.ts +83 -0
- package/src/models/ScriptRunsResBody.ts +82 -0
- package/src/models/ScriptRuntime.ts +105 -0
- package/src/models/ScriptSchedule.ts +73 -0
- package/src/models/ScriptSchedulePreviewReqBody.ts +81 -0
- package/src/models/ScriptSchedulePreviewResBody.ts +83 -0
- package/src/models/ScriptSecretsReqBody.ts +73 -0
- package/src/models/ScriptSecretsResBody.ts +225 -0
- package/src/models/ScriptSummary.ts +216 -0
- package/src/models/ScriptWebhookResBody.ts +66 -0
- package/src/models/index.ts +25 -0
|
@@ -63,7 +63,7 @@ export interface AccountsApiInterface {
|
|
|
63
63
|
*/
|
|
64
64
|
create(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
65
65
|
/**
|
|
66
|
-
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
66
|
+
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
67
67
|
* @summary Create the current account\'s OIDC provider
|
|
68
68
|
* @param {AccountPostOIDCProviderReqBody} accountPostOIDCProviderReqBody
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
@@ -72,12 +72,12 @@ export interface AccountsApiInterface {
|
|
|
72
72
|
*/
|
|
73
73
|
createOidcProviderRaw(requestParameters: AccountsApiCreateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOIDCProvider>>;
|
|
74
74
|
/**
|
|
75
|
-
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
75
|
+
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
76
76
|
* Create the current account\'s OIDC provider
|
|
77
77
|
*/
|
|
78
78
|
createOidcProvider(requestParameters: AccountsApiCreateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOIDCProvider>;
|
|
79
79
|
/**
|
|
80
|
-
* Permanently deletes the account the access token was issued for, along with its projects and
|
|
80
|
+
* Permanently deletes the account the access token was issued for, along with its projects, members and scripts. This cannot be undone. Scripts are deleted first, so if the request fails some of them may already be gone; repeat it to finish deleting the account. Requires the *Manage my account* permission. A script\'s own API key cannot delete the account.
|
|
81
81
|
* @summary Delete the current account
|
|
82
82
|
* @param {*} [options] Override http request option.
|
|
83
83
|
* @throws {RequiredError}
|
|
@@ -85,12 +85,12 @@ export interface AccountsApiInterface {
|
|
|
85
85
|
*/
|
|
86
86
|
deleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
87
87
|
/**
|
|
88
|
-
* Permanently deletes the account the access token was issued for, along with its projects and
|
|
88
|
+
* Permanently deletes the account the access token was issued for, along with its projects, members and scripts. This cannot be undone. Scripts are deleted first, so if the request fails some of them may already be gone; repeat it to finish deleting the account. Requires the *Manage my account* permission. A script\'s own API key cannot delete the account.
|
|
89
89
|
* Delete the current account
|
|
90
90
|
*/
|
|
91
91
|
delete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
92
92
|
/**
|
|
93
|
-
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
93
|
+
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
94
94
|
* @summary Delete the current account\'s OIDC provider
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
96
96
|
* @throws {RequiredError}
|
|
@@ -98,7 +98,7 @@ export interface AccountsApiInterface {
|
|
|
98
98
|
*/
|
|
99
99
|
deleteOidcProviderRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
100
100
|
/**
|
|
101
|
-
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
101
|
+
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
102
102
|
* Delete the current account\'s OIDC provider
|
|
103
103
|
*/
|
|
104
104
|
deleteOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -144,7 +144,7 @@ export interface AccountsApiInterface {
|
|
|
144
144
|
*/
|
|
145
145
|
getHostname(requestParameters: AccountsApiGetHostnameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
146
146
|
/**
|
|
147
|
-
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
147
|
+
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
148
148
|
* @summary Get the current account\'s OIDC provider
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
@@ -152,7 +152,7 @@ export interface AccountsApiInterface {
|
|
|
152
152
|
*/
|
|
153
153
|
getOidcProviderRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOIDCProvider>>;
|
|
154
154
|
/**
|
|
155
|
-
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
155
|
+
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
156
156
|
* Get the current account\'s OIDC provider
|
|
157
157
|
*/
|
|
158
158
|
getOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOIDCProvider>;
|
|
@@ -265,7 +265,7 @@ export interface AccountsApiInterface {
|
|
|
265
265
|
*/
|
|
266
266
|
updateAuthOptions(requestParameters: AccountsApiUpdateAuthOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AccountAuthOption>>;
|
|
267
267
|
/**
|
|
268
|
-
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
268
|
+
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
269
269
|
* @summary Update the current account\'s OIDC provider
|
|
270
270
|
* @param {AccountOIDCProviderPatch} accountOIDCProviderPatch
|
|
271
271
|
* @param {*} [options] Override http request option.
|
|
@@ -274,12 +274,12 @@ export interface AccountsApiInterface {
|
|
|
274
274
|
*/
|
|
275
275
|
updateOidcProviderRaw(requestParameters: AccountsApiUpdateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOIDCProvider>>;
|
|
276
276
|
/**
|
|
277
|
-
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
277
|
+
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
278
278
|
* Update the current account\'s OIDC provider
|
|
279
279
|
*/
|
|
280
280
|
updateOidcProvider(requestParameters: AccountsApiUpdateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOIDCProvider>;
|
|
281
281
|
/**
|
|
282
|
-
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
282
|
+
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
283
283
|
* @summary Replace the current account\'s OIDC client secret
|
|
284
284
|
* @param {AccountPutOIDCClientSecretReqBody} accountPutOIDCClientSecretReqBody
|
|
285
285
|
* @param {*} [options] Override http request option.
|
|
@@ -288,7 +288,7 @@ export interface AccountsApiInterface {
|
|
|
288
288
|
*/
|
|
289
289
|
updateOidcProviderClientSecretRaw(requestParameters: AccountsApiUpdateOidcProviderClientSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
290
290
|
/**
|
|
291
|
-
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
291
|
+
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
292
292
|
* Replace the current account\'s OIDC client secret
|
|
293
293
|
*/
|
|
294
294
|
updateOidcProviderClientSecret(requestParameters: AccountsApiUpdateOidcProviderClientSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -308,32 +308,32 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
308
308
|
*/
|
|
309
309
|
create(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
310
310
|
/**
|
|
311
|
-
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
311
|
+
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
312
312
|
* Create the current account\'s OIDC provider
|
|
313
313
|
*/
|
|
314
314
|
createOidcProviderRaw(requestParameters: AccountsApiCreateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOIDCProvider>>;
|
|
315
315
|
/**
|
|
316
|
-
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
316
|
+
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
317
317
|
* Create the current account\'s OIDC provider
|
|
318
318
|
*/
|
|
319
319
|
createOidcProvider(requestParameters: AccountsApiCreateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOIDCProvider>;
|
|
320
320
|
/**
|
|
321
|
-
* Permanently deletes the account the access token was issued for, along with its projects and
|
|
321
|
+
* Permanently deletes the account the access token was issued for, along with its projects, members and scripts. This cannot be undone. Scripts are deleted first, so if the request fails some of them may already be gone; repeat it to finish deleting the account. Requires the *Manage my account* permission. A script\'s own API key cannot delete the account.
|
|
322
322
|
* Delete the current account
|
|
323
323
|
*/
|
|
324
324
|
deleteRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
325
325
|
/**
|
|
326
|
-
* Permanently deletes the account the access token was issued for, along with its projects and
|
|
326
|
+
* Permanently deletes the account the access token was issued for, along with its projects, members and scripts. This cannot be undone. Scripts are deleted first, so if the request fails some of them may already be gone; repeat it to finish deleting the account. Requires the *Manage my account* permission. A script\'s own API key cannot delete the account.
|
|
327
327
|
* Delete the current account
|
|
328
328
|
*/
|
|
329
329
|
delete(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
330
330
|
/**
|
|
331
|
-
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
331
|
+
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
332
332
|
* Delete the current account\'s OIDC provider
|
|
333
333
|
*/
|
|
334
334
|
deleteOidcProviderRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
335
335
|
/**
|
|
336
|
-
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
336
|
+
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
337
337
|
* Delete the current account\'s OIDC provider
|
|
338
338
|
*/
|
|
339
339
|
deleteOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -368,12 +368,12 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
368
368
|
*/
|
|
369
369
|
getHostname(requestParameters: AccountsApiGetHostnameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
370
370
|
/**
|
|
371
|
-
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
371
|
+
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
372
372
|
* Get the current account\'s OIDC provider
|
|
373
373
|
*/
|
|
374
374
|
getOidcProviderRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOIDCProvider>>;
|
|
375
375
|
/**
|
|
376
|
-
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
376
|
+
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
377
377
|
* Get the current account\'s OIDC provider
|
|
378
378
|
*/
|
|
379
379
|
getOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOIDCProvider>;
|
|
@@ -458,22 +458,22 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
458
458
|
*/
|
|
459
459
|
updateAuthOptions(requestParameters: AccountsApiUpdateAuthOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AccountAuthOption>>;
|
|
460
460
|
/**
|
|
461
|
-
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
461
|
+
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
462
462
|
* Update the current account\'s OIDC provider
|
|
463
463
|
*/
|
|
464
464
|
updateOidcProviderRaw(requestParameters: AccountsApiUpdateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountOIDCProvider>>;
|
|
465
465
|
/**
|
|
466
|
-
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
466
|
+
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
467
467
|
* Update the current account\'s OIDC provider
|
|
468
468
|
*/
|
|
469
469
|
updateOidcProvider(requestParameters: AccountsApiUpdateOidcProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountOIDCProvider>;
|
|
470
470
|
/**
|
|
471
|
-
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
471
|
+
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
472
472
|
* Replace the current account\'s OIDC client secret
|
|
473
473
|
*/
|
|
474
474
|
updateOidcProviderClientSecretRaw(requestParameters: AccountsApiUpdateOidcProviderClientSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
475
475
|
/**
|
|
476
|
-
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
476
|
+
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
477
477
|
* Replace the current account\'s OIDC client secret
|
|
478
478
|
*/
|
|
479
479
|
updateOidcProviderClientSecret(requestParameters: AccountsApiUpdateOidcProviderClientSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -72,7 +72,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
75
|
+
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
76
76
|
* Create the current account\'s OIDC provider
|
|
77
77
|
*/
|
|
78
78
|
createOidcProviderRaw(requestParameters, initOverrides) {
|
|
@@ -102,7 +102,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
102
102
|
});
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
105
|
+
* Registers the identity provider members of the account the access token was issued for sign in through with single sign-on. An account has at most one provider; creating a second returns `409 oidc-provider-exists`. Creating a provider does not enable the `sso` sign-in method; enable it with `PATCH /v1/account/auth-options` afterwards. The tenant must name a single organisation (Microsoft\'s `common`, `organizations` and `consumers` are rejected) or the request returns `400 invalid-tenant`. The provider\'s OpenID discovery document is fetched before anything is stored, and a provider that cannot be reached returns `400 oidc-discovery-failed`. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
106
106
|
* Create the current account\'s OIDC provider
|
|
107
107
|
*/
|
|
108
108
|
createOidcProvider(requestParameters, initOverrides) {
|
|
@@ -112,7 +112,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
112
112
|
});
|
|
113
113
|
}
|
|
114
114
|
/**
|
|
115
|
-
* Permanently deletes the account the access token was issued for, along with its projects and
|
|
115
|
+
* Permanently deletes the account the access token was issued for, along with its projects, members and scripts. This cannot be undone. Scripts are deleted first, so if the request fails some of them may already be gone; repeat it to finish deleting the account. Requires the *Manage my account* permission. A script\'s own API key cannot delete the account.
|
|
116
116
|
* Delete the current account
|
|
117
117
|
*/
|
|
118
118
|
deleteRaw(initOverrides) {
|
|
@@ -137,7 +137,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
|
-
* Permanently deletes the account the access token was issued for, along with its projects and
|
|
140
|
+
* Permanently deletes the account the access token was issued for, along with its projects, members and scripts. This cannot be undone. Scripts are deleted first, so if the request fails some of them may already be gone; repeat it to finish deleting the account. Requires the *Manage my account* permission. A script\'s own API key cannot delete the account.
|
|
141
141
|
* Delete the current account
|
|
142
142
|
*/
|
|
143
143
|
delete(initOverrides) {
|
|
@@ -146,7 +146,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
146
146
|
});
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
149
|
+
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
150
150
|
* Delete the current account\'s OIDC provider
|
|
151
151
|
*/
|
|
152
152
|
deleteOidcProviderRaw(initOverrides) {
|
|
@@ -171,7 +171,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
171
171
|
});
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
|
-
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
174
|
+
* Removes the identity provider of the account the access token was issued for, together with its client secret, and disables the `sso` sign-in method in the same change. Sessions signed in through the provider can no longer refresh an access token scoped to the account. Returns `400 last-auth-option-disabled` when single sign-on is the account\'s only enabled member sign-in method, `404 oidc-provider-not-configured` when the account has no provider, and `409 auth-options-changed` when the account\'s sign-in methods or its provider changed concurrently, in which case the request may be retried. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
175
175
|
* Delete the current account\'s OIDC provider
|
|
176
176
|
*/
|
|
177
177
|
deleteOidcProvider(initOverrides) {
|
|
@@ -284,7 +284,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
284
284
|
});
|
|
285
285
|
}
|
|
286
286
|
/**
|
|
287
|
-
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
287
|
+
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
288
288
|
* Get the current account\'s OIDC provider
|
|
289
289
|
*/
|
|
290
290
|
getOidcProviderRaw(initOverrides) {
|
|
@@ -309,7 +309,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
309
309
|
});
|
|
310
310
|
}
|
|
311
311
|
/**
|
|
312
|
-
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
312
|
+
* Returns the identity provider members of the account the access token was issued for sign in through with single sign-on. The client secret is never returned; `clientSecretSet` reports whether one is stored. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 sso-multiple-providers` when it has more than one. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
313
313
|
* Get the current account\'s OIDC provider
|
|
314
314
|
*/
|
|
315
315
|
getOidcProvider(initOverrides) {
|
|
@@ -614,7 +614,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
614
614
|
});
|
|
615
615
|
}
|
|
616
616
|
/**
|
|
617
|
-
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
617
|
+
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
618
618
|
* Update the current account\'s OIDC provider
|
|
619
619
|
*/
|
|
620
620
|
updateOidcProviderRaw(requestParameters, initOverrides) {
|
|
@@ -644,7 +644,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
644
644
|
});
|
|
645
645
|
}
|
|
646
646
|
/**
|
|
647
|
-
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
647
|
+
* Changes the identity provider members of the account the access token was issued for sign in through with single sign-on. Fields left out keep their current value; the client secret is changed with `PUT /v1/account/oidc-provider/client-secret`. When `providerName` or `tenant` changes, the tenant must name a single organisation or the request returns `400 invalid-tenant`, and the provider\'s OpenID discovery document is fetched before anything is stored; a provider that cannot be reached returns `400 oidc-discovery-failed`. Returns `404 oidc-provider-not-configured` when the account has no provider, and `409 oidc-provider-changed` when it was changed concurrently. The change is written to the audit log. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
648
648
|
* Update the current account\'s OIDC provider
|
|
649
649
|
*/
|
|
650
650
|
updateOidcProvider(requestParameters, initOverrides) {
|
|
@@ -654,7 +654,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
654
654
|
});
|
|
655
655
|
}
|
|
656
656
|
/**
|
|
657
|
-
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
657
|
+
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
658
658
|
* Replace the current account\'s OIDC client secret
|
|
659
659
|
*/
|
|
660
660
|
updateOidcProviderClientSecretRaw(requestParameters, initOverrides) {
|
|
@@ -684,7 +684,7 @@ export class AccountsApi extends runtime.BaseAPI {
|
|
|
684
684
|
});
|
|
685
685
|
}
|
|
686
686
|
/**
|
|
687
|
-
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`.
|
|
687
|
+
* Stores a new client secret for the identity provider of the account the access token was issued for. The secret is write-only: no endpoint returns it. Returns `404 oidc-provider-not-configured` when the account has no provider. The change is written to the audit log without the secret. Requires the *Manage my account* permission. The account owning the centrally managed shared provider gets `403 shared-sso-provider`. A script\'s own API key cannot call it.
|
|
688
688
|
* Replace the current account\'s OIDC client secret
|
|
689
689
|
*/
|
|
690
690
|
updateOidcProviderClientSecret(requestParameters, initOverrides) {
|
|
@@ -10,13 +10,16 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { AssistantChatPollBody, AssistantChatReq, AssistantChatRes, AssistantConfigBody, AssistantConfigPutReq, AssistantConversationListRes, AssistantModelListBody } from '../models/index';
|
|
13
|
+
import type { AssistantChatPollBody, AssistantChatReq, AssistantChatRes, AssistantConfigBody, AssistantConfigPutReq, AssistantConversationListRes, AssistantModelListBody, AssistantTranscriptBody } from '../models/index';
|
|
14
14
|
export interface AssistantApiCreateChatRequest {
|
|
15
15
|
assistantChatReq?: AssistantChatReq;
|
|
16
16
|
}
|
|
17
17
|
export interface AssistantApiDeleteConversationsRequest {
|
|
18
18
|
id: string;
|
|
19
19
|
}
|
|
20
|
+
export interface AssistantApiGetConversationsTranscriptRequest {
|
|
21
|
+
id: string;
|
|
22
|
+
}
|
|
20
23
|
export interface AssistantApiPollConversationsRequest {
|
|
21
24
|
id: string;
|
|
22
25
|
since?: string;
|
|
@@ -75,6 +78,20 @@ export interface AssistantApiInterface {
|
|
|
75
78
|
* Get the assistant configuration
|
|
76
79
|
*/
|
|
77
80
|
getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
|
|
81
|
+
/**
|
|
82
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
83
|
+
* @summary Get a conversation\'s transcript
|
|
84
|
+
* @param {string} id UUID of the conversation to read.
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
* @memberof AssistantApiInterface
|
|
88
|
+
*/
|
|
89
|
+
getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
|
|
90
|
+
/**
|
|
91
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
92
|
+
* Get a conversation\'s transcript
|
|
93
|
+
*/
|
|
94
|
+
getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
|
|
78
95
|
/**
|
|
79
96
|
* Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
|
|
80
97
|
* @summary List conversations
|
|
@@ -179,6 +196,16 @@ export declare class AssistantApi extends runtime.BaseAPI implements AssistantAp
|
|
|
179
196
|
* Get the assistant configuration
|
|
180
197
|
*/
|
|
181
198
|
getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
|
|
199
|
+
/**
|
|
200
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
201
|
+
* Get a conversation\'s transcript
|
|
202
|
+
*/
|
|
203
|
+
getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
|
|
204
|
+
/**
|
|
205
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
206
|
+
* Get a conversation\'s transcript
|
|
207
|
+
*/
|
|
208
|
+
getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
|
|
182
209
|
/**
|
|
183
210
|
* Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
|
|
184
211
|
* List conversations
|
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { AssistantChatPollBodyFromJSON, AssistantChatReqToJSON, AssistantChatResFromJSON, AssistantConfigBodyFromJSON, AssistantConfigPutReqToJSON, AssistantConversationListResFromJSON, AssistantModelListBodyFromJSON, } from '../models/index';
|
|
24
|
+
import { AssistantChatPollBodyFromJSON, AssistantChatReqToJSON, AssistantChatResFromJSON, AssistantConfigBodyFromJSON, AssistantConfigPutReqToJSON, AssistantConversationListResFromJSON, AssistantModelListBodyFromJSON, AssistantTranscriptBodyFromJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -136,6 +136,45 @@ export class AssistantApi extends runtime.BaseAPI {
|
|
|
136
136
|
return yield response.value();
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
|
+
/**
|
|
140
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
141
|
+
* Get a conversation\'s transcript
|
|
142
|
+
*/
|
|
143
|
+
getConversationsTranscriptRaw(requestParameters, initOverrides) {
|
|
144
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
145
|
+
if (requestParameters['id'] == null) {
|
|
146
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getConversationsTranscript().');
|
|
147
|
+
}
|
|
148
|
+
const queryParameters = {};
|
|
149
|
+
const headerParameters = {};
|
|
150
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
151
|
+
const token = this.configuration.accessToken;
|
|
152
|
+
const tokenString = yield token("accessToken", []);
|
|
153
|
+
if (tokenString) {
|
|
154
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
let urlPath = `/v1/assistant/conversations/{id}/transcript`;
|
|
158
|
+
urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
|
|
159
|
+
const response = yield this.request({
|
|
160
|
+
path: urlPath,
|
|
161
|
+
method: 'GET',
|
|
162
|
+
headers: headerParameters,
|
|
163
|
+
query: queryParameters,
|
|
164
|
+
}, initOverrides);
|
|
165
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AssistantTranscriptBodyFromJSON(jsonValue));
|
|
166
|
+
});
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
|
|
170
|
+
* Get a conversation\'s transcript
|
|
171
|
+
*/
|
|
172
|
+
getConversationsTranscript(requestParameters, initOverrides) {
|
|
173
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
174
|
+
const response = yield this.getConversationsTranscriptRaw(requestParameters, initOverrides);
|
|
175
|
+
return yield response.value();
|
|
176
|
+
});
|
|
177
|
+
}
|
|
139
178
|
/**
|
|
140
179
|
* Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
|
|
141
180
|
* List conversations
|
|
@@ -29,7 +29,7 @@ export interface AuditLogApiInterface {
|
|
|
29
29
|
/**
|
|
30
30
|
* Returns a paginated list of audit-log entries for the account. Specify `entity` to restrict to a single entity type, or pass `entity=all` to retrieve changes across every type the caller has permission to see. Use `nextCursor` from the response as the `cursor` query parameter to fetch the next page.
|
|
31
31
|
* @summary Query the audit log
|
|
32
|
-
* @param {string} [entity] Entity type to query. One of: dashboard, property, scenario, floorplan, space-ruleset, top-down-model, object-group, datacollection, contribution, i18n, user, file, variable, upload-quarantine. Pass \"all\" to retrieve entries across all entity types the caller has permission to see (entityId must be omitted).
|
|
32
|
+
* @param {string} [entity] Entity type to query. One of: dashboard, property, scenario, floorplan, space-ruleset, top-down-model, object-group, datacollection, contribution, i18n, user, file, variable, script, upload-quarantine. Pass \"all\" to retrieve entries across all entity types the caller has permission to see (entityId must be omitted).
|
|
33
33
|
* @param {string} [entityId] Restrict results to changes made to this specific entity. Cannot be used when entity=all.
|
|
34
34
|
* @param {Date} [from] Return only entries at or after this timestamp (RFC 3339). Omit for no lower bound.
|
|
35
35
|
* @param {Date} [to] Return only entries at or before this timestamp (RFC 3339). Omit for no upper bound.
|
|
@@ -59,7 +59,7 @@ export interface AuthenticationApiUpdateAuthPasswordRequest {
|
|
|
59
59
|
*/
|
|
60
60
|
export interface AuthenticationApiInterface {
|
|
61
61
|
/**
|
|
62
|
-
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90.
|
|
62
|
+
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90. A script\'s own API key cannot create or delete keys.
|
|
63
63
|
* @summary Create an API key
|
|
64
64
|
* @param {ApiKeyPostReqBody} apiKeyPostReqBody
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
@@ -68,7 +68,7 @@ export interface AuthenticationApiInterface {
|
|
|
68
68
|
*/
|
|
69
69
|
createApiKeysRaw(requestParameters: AuthenticationApiCreateApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyPostResBody>>;
|
|
70
70
|
/**
|
|
71
|
-
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90.
|
|
71
|
+
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90. A script\'s own API key cannot create or delete keys.
|
|
72
72
|
* Create an API key
|
|
73
73
|
*/
|
|
74
74
|
createApiKeys(requestParameters: AuthenticationApiCreateApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyPostResBody>;
|
|
@@ -188,7 +188,7 @@ export interface AuthenticationApiInterface {
|
|
|
188
188
|
*/
|
|
189
189
|
createAuthSendToken(requestParameters: AuthenticationApiCreateAuthSendTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
190
190
|
/**
|
|
191
|
-
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out.
|
|
191
|
+
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out. Keys that belong to a script are rejected with 409; delete or re-authorise the script instead.
|
|
192
192
|
* @summary Revoke an API key
|
|
193
193
|
* @param {number} id
|
|
194
194
|
* @param {*} [options] Override http request option.
|
|
@@ -197,7 +197,7 @@ export interface AuthenticationApiInterface {
|
|
|
197
197
|
*/
|
|
198
198
|
deleteApiKeysRaw(requestParameters: AuthenticationApiDeleteApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
199
199
|
/**
|
|
200
|
-
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out.
|
|
200
|
+
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out. Keys that belong to a script are rejected with 409; delete or re-authorise the script instead.
|
|
201
201
|
* Revoke an API key
|
|
202
202
|
*/
|
|
203
203
|
deleteApiKeys(requestParameters: AuthenticationApiDeleteApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -249,12 +249,12 @@ export interface AuthenticationApiInterface {
|
|
|
249
249
|
*/
|
|
250
250
|
export declare class AuthenticationApi extends runtime.BaseAPI implements AuthenticationApiInterface {
|
|
251
251
|
/**
|
|
252
|
-
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90.
|
|
252
|
+
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90. A script\'s own API key cannot create or delete keys.
|
|
253
253
|
* Create an API key
|
|
254
254
|
*/
|
|
255
255
|
createApiKeysRaw(requestParameters: AuthenticationApiCreateApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyPostResBody>>;
|
|
256
256
|
/**
|
|
257
|
-
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90.
|
|
257
|
+
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90. A script\'s own API key cannot create or delete keys.
|
|
258
258
|
* Create an API key
|
|
259
259
|
*/
|
|
260
260
|
createApiKeys(requestParameters: AuthenticationApiCreateApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyPostResBody>;
|
|
@@ -339,12 +339,12 @@ export declare class AuthenticationApi extends runtime.BaseAPI implements Authen
|
|
|
339
339
|
*/
|
|
340
340
|
createAuthSendToken(requestParameters: AuthenticationApiCreateAuthSendTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
341
341
|
/**
|
|
342
|
-
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out.
|
|
342
|
+
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out. Keys that belong to a script are rejected with 409; delete or re-authorise the script instead.
|
|
343
343
|
* Revoke an API key
|
|
344
344
|
*/
|
|
345
345
|
deleteApiKeysRaw(requestParameters: AuthenticationApiDeleteApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
346
346
|
/**
|
|
347
|
-
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out.
|
|
347
|
+
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out. Keys that belong to a script are rejected with 409; delete or re-authorise the script instead.
|
|
348
348
|
* Revoke an API key
|
|
349
349
|
*/
|
|
350
350
|
deleteApiKeys(requestParameters: AuthenticationApiDeleteApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -27,7 +27,7 @@ import { APIKeyFromJSON, ApiKeyPostReqBodyToJSON, ApiKeyPostResBodyFromJSON, Aut
|
|
|
27
27
|
*/
|
|
28
28
|
export class AuthenticationApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90.
|
|
30
|
+
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90. A script\'s own API key cannot create or delete keys.
|
|
31
31
|
* Create an API key
|
|
32
32
|
*/
|
|
33
33
|
createApiKeysRaw(requestParameters, initOverrides) {
|
|
@@ -57,7 +57,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
|
|
|
57
57
|
});
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90.
|
|
60
|
+
* Issues a long-lived key for programmatic access, scoped to the calling user and the given project. The secret is returned in the `key` field of this response and never again, since only its hash is stored; a client that loses it must create a replacement. Keys expire after `expiresInDays`, between 1 and 90. A script\'s own API key cannot create or delete keys.
|
|
61
61
|
* Create an API key
|
|
62
62
|
*/
|
|
63
63
|
createApiKeys(requestParameters, initOverrides) {
|
|
@@ -323,7 +323,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
|
|
|
323
323
|
});
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
|
-
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out.
|
|
326
|
+
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out. Keys that belong to a script are rejected with 409; delete or re-authorise the script instead.
|
|
327
327
|
* Revoke an API key
|
|
328
328
|
*/
|
|
329
329
|
deleteApiKeysRaw(requestParameters, initOverrides) {
|
|
@@ -352,7 +352,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
|
|
|
352
352
|
});
|
|
353
353
|
}
|
|
354
354
|
/**
|
|
355
|
-
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out.
|
|
355
|
+
* Permanently revokes one of the calling user\'s keys. Access tokens already exchanged for it remain valid until they expire, and the key itself may continue to authenticate for up to a minute while cached resolutions age out. Keys that belong to a script are rejected with 409; delete or re-authorise the script instead.
|
|
356
356
|
* Revoke an API key
|
|
357
357
|
*/
|
|
358
358
|
deleteApiKeys(requestParameters, initOverrides) {
|