@lumoauth/api-client 1.4.0 → 1.5.0
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 +12 -0
- package/README.md +12 -5
- package/api/admin-agents-api.ts +36 -10
- package/api/admin-mcp-api.ts +5 -5
- package/api/admin-oauth-clients-api.ts +5 -5
- package/api/admin-sandbox-api.ts +5 -5
- package/api/admin-users-api.ts +27 -26
- package/api/admin-webhooks-api.ts +25 -25
- package/api/oauth-api.ts +111 -0
- package/dist/api/admin-agents-api.d.ts +21 -4
- package/dist/api/admin-agents-api.js +18 -10
- package/dist/api/admin-mcp-api.d.ts +5 -5
- package/dist/api/admin-mcp-api.js +4 -4
- package/dist/api/admin-oauth-clients-api.d.ts +5 -5
- package/dist/api/admin-oauth-clients-api.js +4 -4
- package/dist/api/admin-sandbox-api.d.ts +5 -5
- package/dist/api/admin-sandbox-api.js +4 -4
- package/dist/api/admin-users-api.d.ts +27 -26
- package/dist/api/admin-users-api.js +21 -20
- package/dist/api/admin-webhooks-api.d.ts +25 -25
- package/dist/api/admin-webhooks-api.js +20 -20
- package/dist/api/oauth-api.d.ts +65 -0
- package/dist/api/oauth-api.js +72 -0
- package/dist/esm/api/admin-agents-api.d.ts +21 -4
- package/dist/esm/api/admin-agents-api.js +18 -10
- package/dist/esm/api/admin-mcp-api.d.ts +5 -5
- package/dist/esm/api/admin-mcp-api.js +4 -4
- package/dist/esm/api/admin-oauth-clients-api.d.ts +5 -5
- package/dist/esm/api/admin-oauth-clients-api.js +4 -4
- package/dist/esm/api/admin-sandbox-api.d.ts +5 -5
- package/dist/esm/api/admin-sandbox-api.js +4 -4
- package/dist/esm/api/admin-users-api.d.ts +27 -26
- package/dist/esm/api/admin-users-api.js +21 -20
- package/dist/esm/api/admin-webhooks-api.d.ts +25 -25
- package/dist/esm/api/admin-webhooks-api.js +20 -20
- package/dist/esm/api/oauth-api.d.ts +65 -0
- package/dist/esm/api/oauth-api.js +73 -1
- package/dist/esm/models/admin-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-request.js +14 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/esm/models/admin-agents-create-request.d.ts +8 -0
- package/dist/esm/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/esm/models/admin-identities-link-request.d.ts +8 -1
- package/dist/esm/models/admin-identities-link-request.js +1 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.js +14 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/esm/models/attest-response-identity.d.ts +1 -1
- package/dist/esm/models/audit-log-entry.d.ts +1 -1
- package/dist/esm/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/esm/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/esm/models/authentication-settings.d.ts +13 -15
- package/dist/esm/models/authentication-settings.js +11 -0
- package/dist/esm/models/get-approval-status-response-approved-by.d.ts +2 -2
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/esm/models/list-permissions-response-permissions-item.d.ts +1 -1
- package/dist/esm/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/esm/models/oauth-client.d.ts +6 -0
- package/dist/esm/models/push-enrollment-started.d.ts +1 -1
- package/dist/esm/models/put-admin-agents-update-request.d.ts +8 -0
- package/dist/esm/models/request-magic-link-request.d.ts +42 -0
- package/dist/esm/models/request-magic-link-request.js +14 -0
- package/dist/esm/models/request-magic-link-response.d.ts +31 -0
- package/dist/esm/models/request-magic-link-response.js +21 -0
- package/dist/esm/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/esm/models/scim-settings-inbound.d.ts +0 -8
- package/dist/esm/models/scim-settings-outbound.d.ts +2 -10
- package/dist/models/admin-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/models/admin-agents-agents-rotate-key-request.js +15 -0
- package/dist/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/models/admin-agents-create-request.d.ts +8 -0
- package/dist/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/models/admin-identities-link-request.d.ts +8 -1
- package/dist/models/admin-identities-link-request.js +1 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/models/admin-sandbox-spawn-response-data.js +15 -0
- package/dist/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/models/admin-sandbox-spawn-response-data1.js +15 -0
- package/dist/models/admin-sandbox-spawn-response.d.ts +3 -3
- package/dist/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/models/admin-webhooks-delivery-replay-response-data.js +15 -0
- package/dist/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/models/attest-response-identity.d.ts +1 -1
- package/dist/models/audit-log-entry.d.ts +1 -1
- package/dist/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/models/authentication-settings.d.ts +13 -15
- package/dist/models/authentication-settings.js +12 -1
- package/dist/models/get-approval-status-response-approved-by.d.ts +2 -2
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/list-permissions-response-permissions-item.d.ts +1 -1
- package/dist/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/models/oauth-client.d.ts +6 -0
- package/dist/models/push-enrollment-started.d.ts +1 -1
- package/dist/models/put-admin-agents-update-request.d.ts +8 -0
- package/dist/models/request-magic-link-request.d.ts +42 -0
- package/dist/models/request-magic-link-request.js +15 -0
- package/dist/models/request-magic-link-response.d.ts +31 -0
- package/dist/models/request-magic-link-response.js +24 -0
- package/dist/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/models/scim-settings-inbound.d.ts +0 -8
- package/dist/models/scim-settings-outbound.d.ts +2 -10
- package/docs/AAuthApi.md +1 -1
- package/docs/AdminAbacApi.md +1 -1
- package/docs/AdminAgentsAgentsRotateKeyRequest.md +22 -0
- package/docs/AdminAgentsAgentsRotateKeyResponse.md +2 -0
- package/docs/AdminAgentsApi.md +20 -8
- package/docs/AdminAgentsCreateRequest.md +2 -0
- package/docs/AdminAuditLogsRetentionResponseData.md +9 -3
- package/docs/AdminIdentitiesLinkRequest.md +3 -1
- package/docs/AdminIdentitiesListResponseDataBindingsItem.md +2 -0
- package/docs/AdminMcpApi.md +2 -1
- package/docs/AdminOAuthClientsApi.md +2 -2
- package/docs/AdminSandboxApi.md +3 -1
- package/docs/AdminSandboxSpawnResponse.md +1 -1
- package/docs/AdminSandboxSpawnResponseData.md +32 -0
- package/docs/AdminSandboxSpawnResponseData1.md +20 -0
- package/docs/AdminUsersApi.md +8 -8
- package/docs/AdminWebhooksApi.md +7 -5
- package/docs/AdminWebhooksDeliveryReplayResponse.md +1 -1
- package/docs/AdminWebhooksDeliveryReplayResponseData.md +28 -0
- package/docs/AdminWebhooksTestResponse.md +2 -0
- package/docs/AgentsApi.md +6 -3
- package/docs/AttestResponseIdentity.md +1 -1
- package/docs/AuditLogEntry.md +1 -1
- package/docs/AuthenticationSettings.md +2 -6
- package/docs/AuthenticationSettingsPasswordPolicy.md +9 -0
- package/docs/AuthenticationSettingsPasswordRotationPolicy.md +1 -4
- package/docs/AuthorizationApi.md +1 -1
- package/docs/CreateClientResponseData.md +3 -1
- package/docs/EnrollAuthenticator201Response.md +1 -1
- package/docs/GetApprovalStatusResponseApprovedBy.md +1 -1
- package/docs/JitApi.md +3 -3
- package/docs/ListPermissionsResponsePermissionsItem.md +1 -1
- package/docs/OAuthApi.md +63 -2
- package/docs/OAuthClient.md +2 -0
- package/docs/OAuthClientSecretIssued.md +1 -1
- package/docs/PushEnrollmentStarted.md +1 -1
- package/docs/PutAdminAgentsUpdateRequest.md +2 -0
- package/docs/RequestMagicLinkRequest.md +26 -0
- package/docs/RequestMagicLinkResponse.md +20 -0
- package/docs/ScimSettingsInbound.md +0 -2
- package/docs/ScimSettingsInboundProtectedAttributes.md +3 -5
- package/docs/ScimSettingsOutbound.md +2 -4
- package/docs/TokenVaultApi.md +2 -2
- package/models/admin-agents-agents-rotate-key-request.ts +36 -0
- package/models/admin-agents-agents-rotate-key-response.ts +6 -0
- package/models/admin-agents-create-request.ts +6 -0
- package/models/admin-audit-logs-retention-response-data.ts +21 -3
- package/models/admin-identities-link-request.ts +8 -1
- package/models/admin-identities-list-response-data-bindings-item.ts +7 -0
- package/models/admin-sandbox-spawn-response-data.ts +29 -0
- package/models/admin-sandbox-spawn-response-data1.ts +30 -0
- package/models/admin-sandbox-spawn-response.ts +3 -3
- package/models/admin-webhooks-delivery-replay-response-data.ts +54 -0
- package/models/admin-webhooks-delivery-replay-response.ts +3 -3
- package/models/admin-webhooks-test-response.ts +6 -0
- package/models/attest-response-identity.ts +1 -1
- package/models/audit-log-entry.ts +1 -1
- package/models/authentication-settings-password-policy.ts +25 -1
- package/models/authentication-settings-password-rotation-policy.ts +1 -13
- package/models/authentication-settings.ts +13 -15
- package/models/get-approval-status-response-approved-by.ts +2 -2
- package/models/index.ts +6 -0
- package/models/list-permissions-response-permissions-item.ts +1 -1
- package/models/oauth-client-secret-issued.ts +1 -1
- package/models/oauth-client.ts +6 -0
- package/models/push-enrollment-started.ts +1 -1
- package/models/put-admin-agents-update-request.ts +6 -0
- package/models/request-magic-link-request.ts +48 -0
- package/models/request-magic-link-response.ts +39 -0
- package/models/scim-settings-inbound-protected-attributes.ts +2 -10
- package/models/scim-settings-inbound.ts +0 -6
- package/models/scim-settings-outbound.ts +2 -8
- package/package.json +1 -1
|
@@ -36,7 +36,7 @@ const base_1 = require("../base");
|
|
|
36
36
|
const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
37
37
|
return {
|
|
38
38
|
/**
|
|
39
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
39
|
+
* Accepts `url`, `events`, `isActive` (also as `active` or `enabled`), `type` and `configuration`. The signing secret is generated server-side and returned once in this response only: a `secret` in the request, an unknown field and an event name that is not in the catalogue are refused with 400.
|
|
40
40
|
* @summary Create a webhook
|
|
41
41
|
* @param {string} orgId
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
@@ -146,7 +146,7 @@ const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
};
|
|
147
147
|
}),
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* Queues a new delivery with the same event and payload and returns its id. The original delivery is not changed. A disabled webhook sends nothing, so the call answers 409 until the webhook is enabled.
|
|
150
150
|
* @summary Replay a delivery
|
|
151
151
|
* @param {string} orgId
|
|
152
152
|
* @param {string} webhookId
|
|
@@ -336,7 +336,7 @@ const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
336
336
|
};
|
|
337
337
|
}),
|
|
338
338
|
/**
|
|
339
|
-
* Generates a new HMAC secret and
|
|
339
|
+
* Generates a new HMAC secret and returns it once. For 24 hours every delivery also carries `X-LumoAuth-Signature-Previous`, signed with the secret that was replaced, so the receiver can be updated without losing events. The `kid` of `X-LumoAuth-Signature` changes with every rotation.
|
|
340
340
|
* @summary Rotate the signing secret
|
|
341
341
|
* @param {string} orgId
|
|
342
342
|
* @param {string} webhookId
|
|
@@ -374,7 +374,7 @@ const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
374
374
|
};
|
|
375
375
|
}),
|
|
376
376
|
/**
|
|
377
|
-
*
|
|
377
|
+
* Sends one `webhook.test` event to the webhook URL now, with the same body, headers and signature as any event, and records it in the delivery history. A receiver answer outside 2xx still yields HTTP 200 with `success: false`; when no answer was received (connection or TLS error) the endpoint answers 502. A failed test is not retried.
|
|
378
378
|
* @summary Send a test delivery
|
|
379
379
|
* @param {string} orgId
|
|
380
380
|
* @param {string} webhookId
|
|
@@ -636,7 +636,7 @@ const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
636
636
|
};
|
|
637
637
|
}),
|
|
638
638
|
/**
|
|
639
|
-
*
|
|
639
|
+
* Changes only the fields that are sent: `url`, `events`, `isActive` (also as `active` or `enabled`), `type`, `configuration`, `rotateSecret`. A new `url` for a webhook that has a signing secret needs `rotateSecret: true`; the response then carries the new `secret` once. Unknown fields, `secret` and event names that are not in the catalogue are refused with 400.
|
|
640
640
|
* @summary Update a webhook
|
|
641
641
|
* @param {string} orgId
|
|
642
642
|
* @param {string} webhookId
|
|
@@ -684,7 +684,7 @@ const AdminWebhooksApiFp = function (configuration) {
|
|
|
684
684
|
const localVarAxiosParamCreator = (0, exports.AdminWebhooksApiAxiosParamCreator)(configuration);
|
|
685
685
|
return {
|
|
686
686
|
/**
|
|
687
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
687
|
+
* Accepts `url`, `events`, `isActive` (also as `active` or `enabled`), `type` and `configuration`. The signing secret is generated server-side and returned once in this response only: a `secret` in the request, an unknown field and an event name that is not in the catalogue are refused with 400.
|
|
688
688
|
* @summary Create a webhook
|
|
689
689
|
* @param {string} orgId
|
|
690
690
|
* @param {*} [options] Override http request option.
|
|
@@ -734,7 +734,7 @@ const AdminWebhooksApiFp = function (configuration) {
|
|
|
734
734
|
});
|
|
735
735
|
},
|
|
736
736
|
/**
|
|
737
|
-
*
|
|
737
|
+
* Queues a new delivery with the same event and payload and returns its id. The original delivery is not changed. A disabled webhook sends nothing, so the call answers 409 until the webhook is enabled.
|
|
738
738
|
* @summary Replay a delivery
|
|
739
739
|
* @param {string} orgId
|
|
740
740
|
* @param {string} webhookId
|
|
@@ -819,7 +819,7 @@ const AdminWebhooksApiFp = function (configuration) {
|
|
|
819
819
|
});
|
|
820
820
|
},
|
|
821
821
|
/**
|
|
822
|
-
* Generates a new HMAC secret and
|
|
822
|
+
* Generates a new HMAC secret and returns it once. For 24 hours every delivery also carries `X-LumoAuth-Signature-Previous`, signed with the secret that was replaced, so the receiver can be updated without losing events. The `kid` of `X-LumoAuth-Signature` changes with every rotation.
|
|
823
823
|
* @summary Rotate the signing secret
|
|
824
824
|
* @param {string} orgId
|
|
825
825
|
* @param {string} webhookId
|
|
@@ -836,7 +836,7 @@ const AdminWebhooksApiFp = function (configuration) {
|
|
|
836
836
|
});
|
|
837
837
|
},
|
|
838
838
|
/**
|
|
839
|
-
*
|
|
839
|
+
* Sends one `webhook.test` event to the webhook URL now, with the same body, headers and signature as any event, and records it in the delivery history. A receiver answer outside 2xx still yields HTTP 200 with `success: false`; when no answer was received (connection or TLS error) the endpoint answers 502. A failed test is not retried.
|
|
840
840
|
* @summary Send a test delivery
|
|
841
841
|
* @param {string} orgId
|
|
842
842
|
* @param {string} webhookId
|
|
@@ -954,7 +954,7 @@ const AdminWebhooksApiFp = function (configuration) {
|
|
|
954
954
|
});
|
|
955
955
|
},
|
|
956
956
|
/**
|
|
957
|
-
*
|
|
957
|
+
* Changes only the fields that are sent: `url`, `events`, `isActive` (also as `active` or `enabled`), `type`, `configuration`, `rotateSecret`. A new `url` for a webhook that has a signing secret needs `rotateSecret: true`; the response then carries the new `secret` once. Unknown fields, `secret` and event names that are not in the catalogue are refused with 400.
|
|
958
958
|
* @summary Update a webhook
|
|
959
959
|
* @param {string} orgId
|
|
960
960
|
* @param {string} webhookId
|
|
@@ -981,7 +981,7 @@ const AdminWebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
981
981
|
const localVarFp = (0, exports.AdminWebhooksApiFp)(configuration);
|
|
982
982
|
return {
|
|
983
983
|
/**
|
|
984
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
984
|
+
* Accepts `url`, `events`, `isActive` (also as `active` or `enabled`), `type` and `configuration`. The signing secret is generated server-side and returned once in this response only: a `secret` in the request, an unknown field and an event name that is not in the catalogue are refused with 400.
|
|
985
985
|
* @summary Create a webhook
|
|
986
986
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
987
987
|
* @param {*} [options] Override http request option.
|
|
@@ -1011,7 +1011,7 @@ const AdminWebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
1011
1011
|
return localVarFp.adminWebhooksDeliveriesList(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
1012
1012
|
},
|
|
1013
1013
|
/**
|
|
1014
|
-
*
|
|
1014
|
+
* Queues a new delivery with the same event and payload and returns its id. The original delivery is not changed. A disabled webhook sends nothing, so the call answers 409 until the webhook is enabled.
|
|
1015
1015
|
* @summary Replay a delivery
|
|
1016
1016
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
1017
1017
|
* @param {*} [options] Override http request option.
|
|
@@ -1061,7 +1061,7 @@ const AdminWebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
1061
1061
|
return localVarFp.adminWebhooksList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1062
1062
|
},
|
|
1063
1063
|
/**
|
|
1064
|
-
* Generates a new HMAC secret and
|
|
1064
|
+
* Generates a new HMAC secret and returns it once. For 24 hours every delivery also carries `X-LumoAuth-Signature-Previous`, signed with the secret that was replaced, so the receiver can be updated without losing events. The `kid` of `X-LumoAuth-Signature` changes with every rotation.
|
|
1065
1065
|
* @summary Rotate the signing secret
|
|
1066
1066
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
1067
1067
|
* @param {*} [options] Override http request option.
|
|
@@ -1071,7 +1071,7 @@ const AdminWebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
1071
1071
|
return localVarFp.adminWebhooksRotateSecret(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
1072
1072
|
},
|
|
1073
1073
|
/**
|
|
1074
|
-
*
|
|
1074
|
+
* Sends one `webhook.test` event to the webhook URL now, with the same body, headers and signature as any event, and records it in the delivery history. A receiver answer outside 2xx still yields HTTP 200 with `success: false`; when no answer was received (connection or TLS error) the endpoint answers 502. A failed test is not retried.
|
|
1075
1075
|
* @summary Send a test delivery
|
|
1076
1076
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
1077
1077
|
* @param {*} [options] Override http request option.
|
|
@@ -1141,7 +1141,7 @@ const AdminWebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
1141
1141
|
return localVarFp.patchAdminWebhooksUpdate(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
1142
1142
|
},
|
|
1143
1143
|
/**
|
|
1144
|
-
*
|
|
1144
|
+
* Changes only the fields that are sent: `url`, `events`, `isActive` (also as `active` or `enabled`), `type`, `configuration`, `rotateSecret`. A new `url` for a webhook that has a signing secret needs `rotateSecret: true`; the response then carries the new `secret` once. Unknown fields, `secret` and event names that are not in the catalogue are refused with 400.
|
|
1145
1145
|
* @summary Update a webhook
|
|
1146
1146
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
1147
1147
|
* @param {*} [options] Override http request option.
|
|
@@ -1161,7 +1161,7 @@ exports.AdminWebhooksApiFactory = AdminWebhooksApiFactory;
|
|
|
1161
1161
|
*/
|
|
1162
1162
|
class AdminWebhooksApi extends base_1.BaseAPI {
|
|
1163
1163
|
/**
|
|
1164
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
1164
|
+
* Accepts `url`, `events`, `isActive` (also as `active` or `enabled`), `type` and `configuration`. The signing secret is generated server-side and returned once in this response only: a `secret` in the request, an unknown field and an event name that is not in the catalogue are refused with 400.
|
|
1165
1165
|
* @summary Create a webhook
|
|
1166
1166
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
1167
1167
|
* @param {*} [options] Override http request option.
|
|
@@ -1194,7 +1194,7 @@ class AdminWebhooksApi extends base_1.BaseAPI {
|
|
|
1194
1194
|
return (0, exports.AdminWebhooksApiFp)(this.configuration).adminWebhooksDeliveriesList(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
1195
1195
|
}
|
|
1196
1196
|
/**
|
|
1197
|
-
*
|
|
1197
|
+
* Queues a new delivery with the same event and payload and returns its id. The original delivery is not changed. A disabled webhook sends nothing, so the call answers 409 until the webhook is enabled.
|
|
1198
1198
|
* @summary Replay a delivery
|
|
1199
1199
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
1200
1200
|
* @param {*} [options] Override http request option.
|
|
@@ -1249,7 +1249,7 @@ class AdminWebhooksApi extends base_1.BaseAPI {
|
|
|
1249
1249
|
return (0, exports.AdminWebhooksApiFp)(this.configuration).adminWebhooksList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1250
1250
|
}
|
|
1251
1251
|
/**
|
|
1252
|
-
* Generates a new HMAC secret and
|
|
1252
|
+
* Generates a new HMAC secret and returns it once. For 24 hours every delivery also carries `X-LumoAuth-Signature-Previous`, signed with the secret that was replaced, so the receiver can be updated without losing events. The `kid` of `X-LumoAuth-Signature` changes with every rotation.
|
|
1253
1253
|
* @summary Rotate the signing secret
|
|
1254
1254
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
1255
1255
|
* @param {*} [options] Override http request option.
|
|
@@ -1260,7 +1260,7 @@ class AdminWebhooksApi extends base_1.BaseAPI {
|
|
|
1260
1260
|
return (0, exports.AdminWebhooksApiFp)(this.configuration).adminWebhooksRotateSecret(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
1261
1261
|
}
|
|
1262
1262
|
/**
|
|
1263
|
-
*
|
|
1263
|
+
* Sends one `webhook.test` event to the webhook URL now, with the same body, headers and signature as any event, and records it in the delivery history. A receiver answer outside 2xx still yields HTTP 200 with `success: false`; when no answer was received (connection or TLS error) the endpoint answers 502. A failed test is not retried.
|
|
1264
1264
|
* @summary Send a test delivery
|
|
1265
1265
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
1266
1266
|
* @param {*} [options] Override http request option.
|
|
@@ -1337,7 +1337,7 @@ class AdminWebhooksApi extends base_1.BaseAPI {
|
|
|
1337
1337
|
return (0, exports.AdminWebhooksApiFp)(this.configuration).patchAdminWebhooksUpdate(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
1338
1338
|
}
|
|
1339
1339
|
/**
|
|
1340
|
-
*
|
|
1340
|
+
* Changes only the fields that are sent: `url`, `events`, `isActive` (also as `active` or `enabled`), `type`, `configuration`, `rotateSecret`. A new `url` for a webhook that has a signing secret needs `rotateSecret: true`; the response then carries the new `secret` once. Unknown fields, `secret` and event names that are not in the catalogue are refused with 400.
|
|
1341
1341
|
* @summary Update a webhook
|
|
1342
1342
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
1343
1343
|
* @param {*} [options] Override http request option.
|
package/dist/api/oauth-api.d.ts
CHANGED
|
@@ -18,6 +18,8 @@ import type { IntrospectResponse } from '../models';
|
|
|
18
18
|
import type { ParResponse } from '../models';
|
|
19
19
|
import type { RegisterClientResponse } from '../models';
|
|
20
20
|
import type { RegisteredClientMetadata } from '../models';
|
|
21
|
+
import type { RequestMagicLinkRequest } from '../models';
|
|
22
|
+
import type { RequestMagicLinkResponse } from '../models';
|
|
21
23
|
import type { SubmitLoginJsonResponse } from '../models';
|
|
22
24
|
import type { TokenResponse } from '../models';
|
|
23
25
|
/**
|
|
@@ -98,6 +100,15 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
98
100
|
* @throws {RequiredError}
|
|
99
101
|
*/
|
|
100
102
|
registerClient: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
103
|
+
/**
|
|
104
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
105
|
+
* @summary Request a sign-in link by email
|
|
106
|
+
* @param {string} orgId
|
|
107
|
+
* @param {RequestMagicLinkRequest} requestMagicLinkRequest
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
requestMagicLink: (orgId: string, requestMagicLinkRequest: RequestMagicLinkRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
112
|
/**
|
|
102
113
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
103
114
|
* @summary Token revocation (RFC 7009)
|
|
@@ -252,6 +263,15 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
|
|
|
252
263
|
* @throws {RequiredError}
|
|
253
264
|
*/
|
|
254
265
|
registerClient(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegisterClientResponse>>;
|
|
266
|
+
/**
|
|
267
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
268
|
+
* @summary Request a sign-in link by email
|
|
269
|
+
* @param {string} orgId
|
|
270
|
+
* @param {RequestMagicLinkRequest} requestMagicLinkRequest
|
|
271
|
+
* @param {*} [options] Override http request option.
|
|
272
|
+
* @throws {RequiredError}
|
|
273
|
+
*/
|
|
274
|
+
requestMagicLink(orgId: string, requestMagicLinkRequest: RequestMagicLinkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestMagicLinkResponse>>;
|
|
255
275
|
/**
|
|
256
276
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
257
277
|
* @summary Token revocation (RFC 7009)
|
|
@@ -405,6 +425,14 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
|
|
|
405
425
|
* @throws {RequiredError}
|
|
406
426
|
*/
|
|
407
427
|
registerClient(requestParameters: OAuthApiRegisterClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<RegisterClientResponse>;
|
|
428
|
+
/**
|
|
429
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
430
|
+
* @summary Request a sign-in link by email
|
|
431
|
+
* @param {OAuthApiRequestMagicLinkRequest} requestParameters Request parameters.
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
requestMagicLink(requestParameters: OAuthApiRequestMagicLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<RequestMagicLinkResponse>;
|
|
408
436
|
/**
|
|
409
437
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
410
438
|
* @summary Token revocation (RFC 7009)
|
|
@@ -565,6 +593,15 @@ export interface OAuthApiInterface {
|
|
|
565
593
|
* @memberof OAuthApiInterface
|
|
566
594
|
*/
|
|
567
595
|
registerClient(requestParameters: OAuthApiRegisterClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<RegisterClientResponse>;
|
|
596
|
+
/**
|
|
597
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
598
|
+
* @summary Request a sign-in link by email
|
|
599
|
+
* @param {OAuthApiRequestMagicLinkRequest} requestParameters Request parameters.
|
|
600
|
+
* @param {*} [options] Override http request option.
|
|
601
|
+
* @throws {RequiredError}
|
|
602
|
+
* @memberof OAuthApiInterface
|
|
603
|
+
*/
|
|
604
|
+
requestMagicLink(requestParameters: OAuthApiRequestMagicLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<RequestMagicLinkResponse>;
|
|
568
605
|
/**
|
|
569
606
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
570
607
|
* @summary Token revocation (RFC 7009)
|
|
@@ -770,6 +807,25 @@ export interface OAuthApiRegisterClientRequest {
|
|
|
770
807
|
*/
|
|
771
808
|
readonly orgId: string;
|
|
772
809
|
}
|
|
810
|
+
/**
|
|
811
|
+
* Request parameters for requestMagicLink operation in OAuthApi.
|
|
812
|
+
* @export
|
|
813
|
+
* @interface OAuthApiRequestMagicLinkRequest
|
|
814
|
+
*/
|
|
815
|
+
export interface OAuthApiRequestMagicLinkRequest {
|
|
816
|
+
/**
|
|
817
|
+
*
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof OAuthApiRequestMagicLink
|
|
820
|
+
*/
|
|
821
|
+
readonly orgId: string;
|
|
822
|
+
/**
|
|
823
|
+
*
|
|
824
|
+
* @type {RequestMagicLinkRequest}
|
|
825
|
+
* @memberof OAuthApiRequestMagicLink
|
|
826
|
+
*/
|
|
827
|
+
readonly requestMagicLinkRequest: RequestMagicLinkRequest;
|
|
828
|
+
}
|
|
773
829
|
/**
|
|
774
830
|
* Request parameters for revoke operation in OAuthApi.
|
|
775
831
|
* @export
|
|
@@ -993,6 +1049,15 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
|
|
|
993
1049
|
* @memberof OAuthApi
|
|
994
1050
|
*/
|
|
995
1051
|
registerClient(requestParameters: OAuthApiRegisterClientRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RegisterClientResponse, any, {}>>;
|
|
1052
|
+
/**
|
|
1053
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
1054
|
+
* @summary Request a sign-in link by email
|
|
1055
|
+
* @param {OAuthApiRequestMagicLinkRequest} requestParameters Request parameters.
|
|
1056
|
+
* @param {*} [options] Override http request option.
|
|
1057
|
+
* @throws {RequiredError}
|
|
1058
|
+
* @memberof OAuthApi
|
|
1059
|
+
*/
|
|
1060
|
+
requestMagicLink(requestParameters: OAuthApiRequestMagicLinkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestMagicLinkResponse, any, {}>>;
|
|
996
1061
|
/**
|
|
997
1062
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
998
1063
|
* @summary Token revocation (RFC 7009)
|
package/dist/api/oauth-api.js
CHANGED
|
@@ -322,6 +322,40 @@ const OAuthApiAxiosParamCreator = function (configuration) {
|
|
|
322
322
|
options: localVarRequestOptions,
|
|
323
323
|
};
|
|
324
324
|
}),
|
|
325
|
+
/**
|
|
326
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
327
|
+
* @summary Request a sign-in link by email
|
|
328
|
+
* @param {string} orgId
|
|
329
|
+
* @param {RequestMagicLinkRequest} requestMagicLinkRequest
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
*/
|
|
333
|
+
requestMagicLink: (orgId_1, requestMagicLinkRequest_1, ...args_1) => __awaiter(this, [orgId_1, requestMagicLinkRequest_1, ...args_1], void 0, function* (orgId, requestMagicLinkRequest, options = {}) {
|
|
334
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
335
|
+
(0, common_1.assertParamExists)('requestMagicLink', 'orgId', orgId);
|
|
336
|
+
// verify required parameter 'requestMagicLinkRequest' is not null or undefined
|
|
337
|
+
(0, common_1.assertParamExists)('requestMagicLink', 'requestMagicLinkRequest', requestMagicLinkRequest);
|
|
338
|
+
const localVarPath = `/orgs/{orgId}/api/v1/oauth/magic-link`
|
|
339
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
340
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
341
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
342
|
+
let baseOptions;
|
|
343
|
+
if (configuration) {
|
|
344
|
+
baseOptions = configuration.baseOptions;
|
|
345
|
+
}
|
|
346
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
347
|
+
const localVarHeaderParameter = {};
|
|
348
|
+
const localVarQueryParameter = {};
|
|
349
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
350
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
351
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
352
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
353
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(requestMagicLinkRequest, localVarRequestOptions, configuration);
|
|
354
|
+
return {
|
|
355
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
356
|
+
options: localVarRequestOptions,
|
|
357
|
+
};
|
|
358
|
+
}),
|
|
325
359
|
/**
|
|
326
360
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
327
361
|
* @summary Token revocation (RFC 7009)
|
|
@@ -756,6 +790,23 @@ const OAuthApiFp = function (configuration) {
|
|
|
756
790
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
757
791
|
});
|
|
758
792
|
},
|
|
793
|
+
/**
|
|
794
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
795
|
+
* @summary Request a sign-in link by email
|
|
796
|
+
* @param {string} orgId
|
|
797
|
+
* @param {RequestMagicLinkRequest} requestMagicLinkRequest
|
|
798
|
+
* @param {*} [options] Override http request option.
|
|
799
|
+
* @throws {RequiredError}
|
|
800
|
+
*/
|
|
801
|
+
requestMagicLink(orgId, requestMagicLinkRequest, options) {
|
|
802
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
803
|
+
var _a, _b, _c;
|
|
804
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.requestMagicLink(orgId, requestMagicLinkRequest, options);
|
|
805
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
806
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OAuthApi.requestMagicLink']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
807
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
808
|
+
});
|
|
809
|
+
},
|
|
759
810
|
/**
|
|
760
811
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
761
812
|
* @summary Token revocation (RFC 7009)
|
|
@@ -1003,6 +1054,16 @@ const OAuthApiFactory = function (configuration, basePath, axios) {
|
|
|
1003
1054
|
registerClient(requestParameters, options) {
|
|
1004
1055
|
return localVarFp.registerClient(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1005
1056
|
},
|
|
1057
|
+
/**
|
|
1058
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
1059
|
+
* @summary Request a sign-in link by email
|
|
1060
|
+
* @param {OAuthApiRequestMagicLinkRequest} requestParameters Request parameters.
|
|
1061
|
+
* @param {*} [options] Override http request option.
|
|
1062
|
+
* @throws {RequiredError}
|
|
1063
|
+
*/
|
|
1064
|
+
requestMagicLink(requestParameters, options) {
|
|
1065
|
+
return localVarFp.requestMagicLink(requestParameters.orgId, requestParameters.requestMagicLinkRequest, options).then((request) => request(axios, basePath));
|
|
1066
|
+
},
|
|
1006
1067
|
/**
|
|
1007
1068
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
1008
1069
|
* @summary Token revocation (RFC 7009)
|
|
@@ -1202,6 +1263,17 @@ class OAuthApi extends base_1.BaseAPI {
|
|
|
1202
1263
|
registerClient(requestParameters, options) {
|
|
1203
1264
|
return (0, exports.OAuthApiFp)(this.configuration).registerClient(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1204
1265
|
}
|
|
1266
|
+
/**
|
|
1267
|
+
* For applications that render their own sign-in form. Mails a single-use sign-in link to the address when it belongs to an account of the organization, and gives the same answer when it does not. Signs nobody in and mints no tokens: the person opens the link, confirms on the hosted page, and is then sent to `return_to`, where the application starts its normal authorization flow. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
1268
|
+
* @summary Request a sign-in link by email
|
|
1269
|
+
* @param {OAuthApiRequestMagicLinkRequest} requestParameters Request parameters.
|
|
1270
|
+
* @param {*} [options] Override http request option.
|
|
1271
|
+
* @throws {RequiredError}
|
|
1272
|
+
* @memberof OAuthApi
|
|
1273
|
+
*/
|
|
1274
|
+
requestMagicLink(requestParameters, options) {
|
|
1275
|
+
return (0, exports.OAuthApiFp)(this.configuration).requestMagicLink(requestParameters.orgId, requestParameters.requestMagicLinkRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1276
|
+
}
|
|
1205
1277
|
/**
|
|
1206
1278
|
* Revokes an access or refresh token (revoking a refresh token also revokes the access tokens issued with it). Requires client authentication. Always sent with Cache-Control: no-store.
|
|
1207
1279
|
* @summary Token revocation (RFC 7009)
|
|
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
15
15
|
import type { AdminAgentsActivateResponse } from '../models';
|
|
16
16
|
import type { AdminAgentsAgentsDisableResponse } from '../models';
|
|
17
17
|
import type { AdminAgentsAgentsEnableResponse } from '../models';
|
|
18
|
+
import type { AdminAgentsAgentsRotateKeyRequest } from '../models';
|
|
18
19
|
import type { AdminAgentsAgentsRotateKeyResponse } from '../models';
|
|
19
20
|
import type { AdminAgentsCreateRequest } from '../models';
|
|
20
21
|
import type { AdminAgentsCreateResponse } from '../models';
|
|
@@ -70,10 +71,11 @@ export declare const AdminAgentsApiAxiosParamCreator: (configuration?: Configura
|
|
|
70
71
|
* @summary Rotate agent API key
|
|
71
72
|
* @param {string} orgId
|
|
72
73
|
* @param {string} agentId
|
|
74
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
73
75
|
* @param {*} [options] Override http request option.
|
|
74
76
|
* @throws {RequiredError}
|
|
75
77
|
*/
|
|
76
|
-
adminAgentsAgentsRotateKey: (orgId: string, agentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
adminAgentsAgentsRotateKey: (orgId: string, agentId: string, adminAgentsAgentsRotateKeyRequest?: AdminAgentsAgentsRotateKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
79
|
/**
|
|
78
80
|
*
|
|
79
81
|
* @summary Create a new agent
|
|
@@ -161,10 +163,11 @@ export declare const AdminAgentsApiAxiosParamCreator: (configuration?: Configura
|
|
|
161
163
|
* @summary Rotate agent credentials
|
|
162
164
|
* @param {string} orgId
|
|
163
165
|
* @param {string} agentId
|
|
166
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
164
167
|
* @param {*} [options] Override http request option.
|
|
165
168
|
* @throws {RequiredError}
|
|
166
169
|
*/
|
|
167
|
-
adminAgentsRotateCredentials: (orgId: string, agentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
170
|
+
adminAgentsRotateCredentials: (orgId: string, agentId: string, adminAgentsAgentsRotateKeyRequest?: AdminAgentsAgentsRotateKeyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
168
171
|
/**
|
|
169
172
|
*
|
|
170
173
|
* @summary Update agent scopes/capabilities
|
|
@@ -233,10 +236,11 @@ export declare const AdminAgentsApiFp: (configuration?: Configuration) => {
|
|
|
233
236
|
* @summary Rotate agent API key
|
|
234
237
|
* @param {string} orgId
|
|
235
238
|
* @param {string} agentId
|
|
239
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
236
240
|
* @param {*} [options] Override http request option.
|
|
237
241
|
* @throws {RequiredError}
|
|
238
242
|
*/
|
|
239
|
-
adminAgentsAgentsRotateKey(orgId: string, agentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsAgentsRotateKeyResponse>>;
|
|
243
|
+
adminAgentsAgentsRotateKey(orgId: string, agentId: string, adminAgentsAgentsRotateKeyRequest?: AdminAgentsAgentsRotateKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsAgentsRotateKeyResponse>>;
|
|
240
244
|
/**
|
|
241
245
|
*
|
|
242
246
|
* @summary Create a new agent
|
|
@@ -324,10 +328,11 @@ export declare const AdminAgentsApiFp: (configuration?: Configuration) => {
|
|
|
324
328
|
* @summary Rotate agent credentials
|
|
325
329
|
* @param {string} orgId
|
|
326
330
|
* @param {string} agentId
|
|
331
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
327
332
|
* @param {*} [options] Override http request option.
|
|
328
333
|
* @throws {RequiredError}
|
|
329
334
|
*/
|
|
330
|
-
adminAgentsRotateCredentials(orgId: string, agentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsRotateCredentialsResponse>>;
|
|
335
|
+
adminAgentsRotateCredentials(orgId: string, agentId: string, adminAgentsAgentsRotateKeyRequest?: AdminAgentsAgentsRotateKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsRotateCredentialsResponse>>;
|
|
331
336
|
/**
|
|
332
337
|
*
|
|
333
338
|
* @summary Update agent scopes/capabilities
|
|
@@ -736,6 +741,12 @@ export interface AdminAgentsApiAdminAgentsAgentsRotateKeyRequest {
|
|
|
736
741
|
* @memberof AdminAgentsApiAdminAgentsAgentsRotateKey
|
|
737
742
|
*/
|
|
738
743
|
readonly agentId: string;
|
|
744
|
+
/**
|
|
745
|
+
* Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
746
|
+
* @type {AdminAgentsAgentsRotateKeyRequest}
|
|
747
|
+
* @memberof AdminAgentsApiAdminAgentsAgentsRotateKey
|
|
748
|
+
*/
|
|
749
|
+
readonly adminAgentsAgentsRotateKeyRequest?: AdminAgentsAgentsRotateKeyRequest;
|
|
739
750
|
}
|
|
740
751
|
/**
|
|
741
752
|
* Request parameters for adminAgentsCreate operation in AdminAgentsApi.
|
|
@@ -932,6 +943,12 @@ export interface AdminAgentsApiAdminAgentsRotateCredentialsRequest {
|
|
|
932
943
|
* @memberof AdminAgentsApiAdminAgentsRotateCredentials
|
|
933
944
|
*/
|
|
934
945
|
readonly agentId: string;
|
|
946
|
+
/**
|
|
947
|
+
* For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
948
|
+
* @type {AdminAgentsAgentsRotateKeyRequest}
|
|
949
|
+
* @memberof AdminAgentsApiAdminAgentsRotateCredentials
|
|
950
|
+
*/
|
|
951
|
+
readonly adminAgentsAgentsRotateKeyRequest?: AdminAgentsAgentsRotateKeyRequest;
|
|
935
952
|
}
|
|
936
953
|
/**
|
|
937
954
|
* Request parameters for adminAgentsSetScopes operation in AdminAgentsApi.
|
|
@@ -151,10 +151,11 @@ export const AdminAgentsApiAxiosParamCreator = function (configuration) {
|
|
|
151
151
|
* @summary Rotate agent API key
|
|
152
152
|
* @param {string} orgId
|
|
153
153
|
* @param {string} agentId
|
|
154
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
154
155
|
* @param {*} [options] Override http request option.
|
|
155
156
|
* @throws {RequiredError}
|
|
156
157
|
*/
|
|
157
|
-
adminAgentsAgentsRotateKey: (orgId_1, agentId_1, ...args_1) => __awaiter(this, [orgId_1, agentId_1, ...args_1], void 0, function* (orgId, agentId, options = {}) {
|
|
158
|
+
adminAgentsAgentsRotateKey: (orgId_1, agentId_1, adminAgentsAgentsRotateKeyRequest_1, ...args_1) => __awaiter(this, [orgId_1, agentId_1, adminAgentsAgentsRotateKeyRequest_1, ...args_1], void 0, function* (orgId, agentId, adminAgentsAgentsRotateKeyRequest, options = {}) {
|
|
158
159
|
// verify required parameter 'orgId' is not null or undefined
|
|
159
160
|
assertParamExists('adminAgentsAgentsRotateKey', 'orgId', orgId);
|
|
160
161
|
// verify required parameter 'agentId' is not null or undefined
|
|
@@ -176,9 +177,11 @@ export const AdminAgentsApiAxiosParamCreator = function (configuration) {
|
|
|
176
177
|
// authentication BearerAuth required
|
|
177
178
|
// http bearer authentication required
|
|
178
179
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
180
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
179
181
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
180
182
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
181
183
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
184
|
+
localVarRequestOptions.data = serializeDataIfNeeded(adminAgentsAgentsRotateKeyRequest, localVarRequestOptions, configuration);
|
|
182
185
|
return {
|
|
183
186
|
url: toPathString(localVarUrlObj),
|
|
184
187
|
options: localVarRequestOptions,
|
|
@@ -536,10 +539,11 @@ export const AdminAgentsApiAxiosParamCreator = function (configuration) {
|
|
|
536
539
|
* @summary Rotate agent credentials
|
|
537
540
|
* @param {string} orgId
|
|
538
541
|
* @param {string} agentId
|
|
542
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
539
543
|
* @param {*} [options] Override http request option.
|
|
540
544
|
* @throws {RequiredError}
|
|
541
545
|
*/
|
|
542
|
-
adminAgentsRotateCredentials: (orgId_1, agentId_1, ...args_1) => __awaiter(this, [orgId_1, agentId_1, ...args_1], void 0, function* (orgId, agentId, options = {}) {
|
|
546
|
+
adminAgentsRotateCredentials: (orgId_1, agentId_1, adminAgentsAgentsRotateKeyRequest_1, ...args_1) => __awaiter(this, [orgId_1, agentId_1, adminAgentsAgentsRotateKeyRequest_1, ...args_1], void 0, function* (orgId, agentId, adminAgentsAgentsRotateKeyRequest, options = {}) {
|
|
543
547
|
// verify required parameter 'orgId' is not null or undefined
|
|
544
548
|
assertParamExists('adminAgentsRotateCredentials', 'orgId', orgId);
|
|
545
549
|
// verify required parameter 'agentId' is not null or undefined
|
|
@@ -561,9 +565,11 @@ export const AdminAgentsApiAxiosParamCreator = function (configuration) {
|
|
|
561
565
|
// authentication BearerAuth required
|
|
562
566
|
// http bearer authentication required
|
|
563
567
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
568
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
564
569
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
565
570
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
566
571
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
572
|
+
localVarRequestOptions.data = serializeDataIfNeeded(adminAgentsAgentsRotateKeyRequest, localVarRequestOptions, configuration);
|
|
567
573
|
return {
|
|
568
574
|
url: toPathString(localVarUrlObj),
|
|
569
575
|
options: localVarRequestOptions,
|
|
@@ -763,13 +769,14 @@ export const AdminAgentsApiFp = function (configuration) {
|
|
|
763
769
|
* @summary Rotate agent API key
|
|
764
770
|
* @param {string} orgId
|
|
765
771
|
* @param {string} agentId
|
|
772
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
766
773
|
* @param {*} [options] Override http request option.
|
|
767
774
|
* @throws {RequiredError}
|
|
768
775
|
*/
|
|
769
|
-
adminAgentsAgentsRotateKey(orgId, agentId, options) {
|
|
776
|
+
adminAgentsAgentsRotateKey(orgId, agentId, adminAgentsAgentsRotateKeyRequest, options) {
|
|
770
777
|
return __awaiter(this, void 0, void 0, function* () {
|
|
771
778
|
var _a, _b, _c;
|
|
772
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAgentsAgentsRotateKey(orgId, agentId, options);
|
|
779
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAgentsAgentsRotateKey(orgId, agentId, adminAgentsAgentsRotateKeyRequest, options);
|
|
773
780
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
774
781
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminAgentsApi.adminAgentsAgentsRotateKey']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
775
782
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -934,13 +941,14 @@ export const AdminAgentsApiFp = function (configuration) {
|
|
|
934
941
|
* @summary Rotate agent credentials
|
|
935
942
|
* @param {string} orgId
|
|
936
943
|
* @param {string} agentId
|
|
944
|
+
* @param {AdminAgentsAgentsRotateKeyRequest} [adminAgentsAgentsRotateKeyRequest] For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days).
|
|
937
945
|
* @param {*} [options] Override http request option.
|
|
938
946
|
* @throws {RequiredError}
|
|
939
947
|
*/
|
|
940
|
-
adminAgentsRotateCredentials(orgId, agentId, options) {
|
|
948
|
+
adminAgentsRotateCredentials(orgId, agentId, adminAgentsAgentsRotateKeyRequest, options) {
|
|
941
949
|
return __awaiter(this, void 0, void 0, function* () {
|
|
942
950
|
var _a, _b, _c;
|
|
943
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAgentsRotateCredentials(orgId, agentId, options);
|
|
951
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAgentsRotateCredentials(orgId, agentId, adminAgentsAgentsRotateKeyRequest, options);
|
|
944
952
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
945
953
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminAgentsApi.adminAgentsRotateCredentials']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
946
954
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1047,7 +1055,7 @@ export const AdminAgentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1047
1055
|
* @throws {RequiredError}
|
|
1048
1056
|
*/
|
|
1049
1057
|
adminAgentsAgentsRotateKey(requestParameters, options) {
|
|
1050
|
-
return localVarFp.adminAgentsAgentsRotateKey(requestParameters.orgId, requestParameters.agentId, options).then((request) => request(axios, basePath));
|
|
1058
|
+
return localVarFp.adminAgentsAgentsRotateKey(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsAgentsRotateKeyRequest, options).then((request) => request(axios, basePath));
|
|
1051
1059
|
},
|
|
1052
1060
|
/**
|
|
1053
1061
|
*
|
|
@@ -1147,7 +1155,7 @@ export const AdminAgentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1147
1155
|
* @throws {RequiredError}
|
|
1148
1156
|
*/
|
|
1149
1157
|
adminAgentsRotateCredentials(requestParameters, options) {
|
|
1150
|
-
return localVarFp.adminAgentsRotateCredentials(requestParameters.orgId, requestParameters.agentId, options).then((request) => request(axios, basePath));
|
|
1158
|
+
return localVarFp.adminAgentsRotateCredentials(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsAgentsRotateKeyRequest, options).then((request) => request(axios, basePath));
|
|
1151
1159
|
},
|
|
1152
1160
|
/**
|
|
1153
1161
|
*
|
|
@@ -1230,7 +1238,7 @@ export class AdminAgentsApi extends BaseAPI {
|
|
|
1230
1238
|
* @memberof AdminAgentsApi
|
|
1231
1239
|
*/
|
|
1232
1240
|
adminAgentsAgentsRotateKey(requestParameters, options) {
|
|
1233
|
-
return AdminAgentsApiFp(this.configuration).adminAgentsAgentsRotateKey(requestParameters.orgId, requestParameters.agentId, options).then((request) => request(this.axios, this.basePath));
|
|
1241
|
+
return AdminAgentsApiFp(this.configuration).adminAgentsAgentsRotateKey(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsAgentsRotateKeyRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1234
1242
|
}
|
|
1235
1243
|
/**
|
|
1236
1244
|
*
|
|
@@ -1340,7 +1348,7 @@ export class AdminAgentsApi extends BaseAPI {
|
|
|
1340
1348
|
* @memberof AdminAgentsApi
|
|
1341
1349
|
*/
|
|
1342
1350
|
adminAgentsRotateCredentials(requestParameters, options) {
|
|
1343
|
-
return AdminAgentsApiFp(this.configuration).adminAgentsRotateCredentials(requestParameters.orgId, requestParameters.agentId, options).then((request) => request(this.axios, this.basePath));
|
|
1351
|
+
return AdminAgentsApiFp(this.configuration).adminAgentsRotateCredentials(requestParameters.orgId, requestParameters.agentId, requestParameters.adminAgentsAgentsRotateKeyRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1344
1352
|
}
|
|
1345
1353
|
/**
|
|
1346
1354
|
*
|