@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
|
@@ -224,8 +224,8 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
224
224
|
};
|
|
225
225
|
}),
|
|
226
226
|
/**
|
|
227
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
228
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
227
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
228
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
229
229
|
* @param {string} orgId
|
|
230
230
|
* @param {string} userId
|
|
231
231
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -267,7 +267,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
267
267
|
};
|
|
268
268
|
}),
|
|
269
269
|
/**
|
|
270
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
270
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
271
271
|
* @summary List a user\'s federated identity links
|
|
272
272
|
* @param {string} orgId
|
|
273
273
|
* @param {string} userId
|
|
@@ -305,8 +305,8 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
305
305
|
};
|
|
306
306
|
}),
|
|
307
307
|
/**
|
|
308
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
309
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
308
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
309
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
310
310
|
* @param {AdminIdentitiesUnlinkType} type
|
|
311
311
|
* @param {string} orgId
|
|
312
312
|
* @param {string} userId
|
|
@@ -1282,8 +1282,8 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1282
1282
|
});
|
|
1283
1283
|
},
|
|
1284
1284
|
/**
|
|
1285
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1286
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1285
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1286
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1287
1287
|
* @param {string} orgId
|
|
1288
1288
|
* @param {string} userId
|
|
1289
1289
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -1300,7 +1300,7 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1300
1300
|
});
|
|
1301
1301
|
},
|
|
1302
1302
|
/**
|
|
1303
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1303
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
1304
1304
|
* @summary List a user\'s federated identity links
|
|
1305
1305
|
* @param {string} orgId
|
|
1306
1306
|
* @param {string} userId
|
|
@@ -1317,8 +1317,8 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1317
1317
|
});
|
|
1318
1318
|
},
|
|
1319
1319
|
/**
|
|
1320
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1321
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1320
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1321
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1322
1322
|
* @param {AdminIdentitiesUnlinkType} type
|
|
1323
1323
|
* @param {string} orgId
|
|
1324
1324
|
* @param {string} userId
|
|
@@ -1770,8 +1770,8 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1770
1770
|
return localVarFp.adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(axios, basePath));
|
|
1771
1771
|
},
|
|
1772
1772
|
/**
|
|
1773
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1774
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1773
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1774
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1775
1775
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
1776
1776
|
* @param {*} [options] Override http request option.
|
|
1777
1777
|
* @throws {RequiredError}
|
|
@@ -1780,7 +1780,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1780
1780
|
return localVarFp.adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(axios, basePath));
|
|
1781
1781
|
},
|
|
1782
1782
|
/**
|
|
1783
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1783
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
1784
1784
|
* @summary List a user\'s federated identity links
|
|
1785
1785
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
1786
1786
|
* @param {*} [options] Override http request option.
|
|
@@ -1790,8 +1790,8 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1790
1790
|
return localVarFp.adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1791
1791
|
},
|
|
1792
1792
|
/**
|
|
1793
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1794
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1793
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1794
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1795
1795
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
1796
1796
|
* @param {*} [options] Override http request option.
|
|
1797
1797
|
* @throws {RequiredError}
|
|
@@ -2085,8 +2085,8 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2085
2085
|
return AdminUsersApiFp(this.configuration).adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(this.axios, this.basePath));
|
|
2086
2086
|
}
|
|
2087
2087
|
/**
|
|
2088
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
2089
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
2088
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
2089
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
2090
2090
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
2091
2091
|
* @param {*} [options] Override http request option.
|
|
2092
2092
|
* @throws {RequiredError}
|
|
@@ -2096,7 +2096,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2096
2096
|
return AdminUsersApiFp(this.configuration).adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2097
2097
|
}
|
|
2098
2098
|
/**
|
|
2099
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
2099
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
2100
2100
|
* @summary List a user\'s federated identity links
|
|
2101
2101
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
2102
2102
|
* @param {*} [options] Override http request option.
|
|
@@ -2107,8 +2107,8 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2107
2107
|
return AdminUsersApiFp(this.configuration).adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2108
2108
|
}
|
|
2109
2109
|
/**
|
|
2110
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
2111
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
2110
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
2111
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
2112
2112
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
2113
2113
|
* @param {*} [options] Override http request option.
|
|
2114
2114
|
* @throws {RequiredError}
|
|
@@ -2368,6 +2368,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2368
2368
|
export var AdminIdentitiesUnlinkType;
|
|
2369
2369
|
(function (AdminIdentitiesUnlinkType) {
|
|
2370
2370
|
AdminIdentitiesUnlinkType["SAML"] = "saml";
|
|
2371
|
+
AdminIdentitiesUnlinkType["OIDC"] = "oidc";
|
|
2371
2372
|
AdminIdentitiesUnlinkType["LDAP"] = "ldap";
|
|
2372
2373
|
AdminIdentitiesUnlinkType["SOCIAL"] = "social";
|
|
2373
2374
|
})(AdminIdentitiesUnlinkType || (AdminIdentitiesUnlinkType = {}));
|
|
@@ -32,7 +32,7 @@ import type { PutAdminWebhooksUpdateResponse } from '../models';
|
|
|
32
32
|
*/
|
|
33
33
|
export declare const AdminWebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34
34
|
/**
|
|
35
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
35
|
+
* 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.
|
|
36
36
|
* @summary Create a webhook
|
|
37
37
|
* @param {string} orgId
|
|
38
38
|
* @param {*} [options] Override http request option.
|
|
@@ -58,7 +58,7 @@ export declare const AdminWebhooksApiAxiosParamCreator: (configuration?: Configu
|
|
|
58
58
|
*/
|
|
59
59
|
adminWebhooksDeliveriesList: (orgId: string, webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* 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.
|
|
62
62
|
* @summary Replay a delivery
|
|
63
63
|
* @param {string} orgId
|
|
64
64
|
* @param {string} webhookId
|
|
@@ -103,7 +103,7 @@ export declare const AdminWebhooksApiAxiosParamCreator: (configuration?: Configu
|
|
|
103
103
|
*/
|
|
104
104
|
adminWebhooksList: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
105
105
|
/**
|
|
106
|
-
* Generates a new HMAC secret and
|
|
106
|
+
* 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.
|
|
107
107
|
* @summary Rotate the signing secret
|
|
108
108
|
* @param {string} orgId
|
|
109
109
|
* @param {string} webhookId
|
|
@@ -112,7 +112,7 @@ export declare const AdminWebhooksApiAxiosParamCreator: (configuration?: Configu
|
|
|
112
112
|
*/
|
|
113
113
|
adminWebhooksRotateSecret: (orgId: string, webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
114
|
/**
|
|
115
|
-
*
|
|
115
|
+
* 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.
|
|
116
116
|
* @summary Send a test delivery
|
|
117
117
|
* @param {string} orgId
|
|
118
118
|
* @param {string} webhookId
|
|
@@ -174,7 +174,7 @@ export declare const AdminWebhooksApiAxiosParamCreator: (configuration?: Configu
|
|
|
174
174
|
*/
|
|
175
175
|
patchAdminWebhooksUpdate: (orgId: string, webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* 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.
|
|
178
178
|
* @summary Update a webhook
|
|
179
179
|
* @param {string} orgId
|
|
180
180
|
* @param {string} webhookId
|
|
@@ -189,7 +189,7 @@ export declare const AdminWebhooksApiAxiosParamCreator: (configuration?: Configu
|
|
|
189
189
|
*/
|
|
190
190
|
export declare const AdminWebhooksApiFp: (configuration?: Configuration) => {
|
|
191
191
|
/**
|
|
192
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
192
|
+
* 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.
|
|
193
193
|
* @summary Create a webhook
|
|
194
194
|
* @param {string} orgId
|
|
195
195
|
* @param {*} [options] Override http request option.
|
|
@@ -215,7 +215,7 @@ export declare const AdminWebhooksApiFp: (configuration?: Configuration) => {
|
|
|
215
215
|
*/
|
|
216
216
|
adminWebhooksDeliveriesList(orgId: string, webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminWebhooksDeliveriesListResponse>>;
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
218
|
+
* 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.
|
|
219
219
|
* @summary Replay a delivery
|
|
220
220
|
* @param {string} orgId
|
|
221
221
|
* @param {string} webhookId
|
|
@@ -260,7 +260,7 @@ export declare const AdminWebhooksApiFp: (configuration?: Configuration) => {
|
|
|
260
260
|
*/
|
|
261
261
|
adminWebhooksList(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminWebhooksListResponse>>;
|
|
262
262
|
/**
|
|
263
|
-
* Generates a new HMAC secret and
|
|
263
|
+
* 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.
|
|
264
264
|
* @summary Rotate the signing secret
|
|
265
265
|
* @param {string} orgId
|
|
266
266
|
* @param {string} webhookId
|
|
@@ -269,7 +269,7 @@ export declare const AdminWebhooksApiFp: (configuration?: Configuration) => {
|
|
|
269
269
|
*/
|
|
270
270
|
adminWebhooksRotateSecret(orgId: string, webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminWebhooksRotateSecretResponse>>;
|
|
271
271
|
/**
|
|
272
|
-
*
|
|
272
|
+
* 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.
|
|
273
273
|
* @summary Send a test delivery
|
|
274
274
|
* @param {string} orgId
|
|
275
275
|
* @param {string} webhookId
|
|
@@ -331,7 +331,7 @@ export declare const AdminWebhooksApiFp: (configuration?: Configuration) => {
|
|
|
331
331
|
*/
|
|
332
332
|
patchAdminWebhooksUpdate(orgId: string, webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAdminWebhooksUpdateResponse>>;
|
|
333
333
|
/**
|
|
334
|
-
*
|
|
334
|
+
* 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.
|
|
335
335
|
* @summary Update a webhook
|
|
336
336
|
* @param {string} orgId
|
|
337
337
|
* @param {string} webhookId
|
|
@@ -346,7 +346,7 @@ export declare const AdminWebhooksApiFp: (configuration?: Configuration) => {
|
|
|
346
346
|
*/
|
|
347
347
|
export declare const AdminWebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
348
348
|
/**
|
|
349
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
349
|
+
* 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.
|
|
350
350
|
* @summary Create a webhook
|
|
351
351
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
@@ -370,7 +370,7 @@ export declare const AdminWebhooksApiFactory: (configuration?: Configuration, ba
|
|
|
370
370
|
*/
|
|
371
371
|
adminWebhooksDeliveriesList(requestParameters: AdminWebhooksApiAdminWebhooksDeliveriesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminWebhooksDeliveriesListResponse>;
|
|
372
372
|
/**
|
|
373
|
-
*
|
|
373
|
+
* 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.
|
|
374
374
|
* @summary Replay a delivery
|
|
375
375
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
376
376
|
* @param {*} [options] Override http request option.
|
|
@@ -410,7 +410,7 @@ export declare const AdminWebhooksApiFactory: (configuration?: Configuration, ba
|
|
|
410
410
|
*/
|
|
411
411
|
adminWebhooksList(requestParameters: AdminWebhooksApiAdminWebhooksListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminWebhooksListResponse>;
|
|
412
412
|
/**
|
|
413
|
-
* Generates a new HMAC secret and
|
|
413
|
+
* 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.
|
|
414
414
|
* @summary Rotate the signing secret
|
|
415
415
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
416
416
|
* @param {*} [options] Override http request option.
|
|
@@ -418,7 +418,7 @@ export declare const AdminWebhooksApiFactory: (configuration?: Configuration, ba
|
|
|
418
418
|
*/
|
|
419
419
|
adminWebhooksRotateSecret(requestParameters: AdminWebhooksApiAdminWebhooksRotateSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminWebhooksRotateSecretResponse>;
|
|
420
420
|
/**
|
|
421
|
-
*
|
|
421
|
+
* 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.
|
|
422
422
|
* @summary Send a test delivery
|
|
423
423
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
424
424
|
* @param {*} [options] Override http request option.
|
|
@@ -474,7 +474,7 @@ export declare const AdminWebhooksApiFactory: (configuration?: Configuration, ba
|
|
|
474
474
|
*/
|
|
475
475
|
patchAdminWebhooksUpdate(requestParameters: AdminWebhooksApiPatchAdminWebhooksUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminWebhooksUpdateResponse>;
|
|
476
476
|
/**
|
|
477
|
-
*
|
|
477
|
+
* 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.
|
|
478
478
|
* @summary Update a webhook
|
|
479
479
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
480
480
|
* @param {*} [options] Override http request option.
|
|
@@ -489,7 +489,7 @@ export declare const AdminWebhooksApiFactory: (configuration?: Configuration, ba
|
|
|
489
489
|
*/
|
|
490
490
|
export interface AdminWebhooksApiInterface {
|
|
491
491
|
/**
|
|
492
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
492
|
+
* 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.
|
|
493
493
|
* @summary Create a webhook
|
|
494
494
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
495
495
|
* @param {*} [options] Override http request option.
|
|
@@ -516,7 +516,7 @@ export interface AdminWebhooksApiInterface {
|
|
|
516
516
|
*/
|
|
517
517
|
adminWebhooksDeliveriesList(requestParameters: AdminWebhooksApiAdminWebhooksDeliveriesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminWebhooksDeliveriesListResponse>;
|
|
518
518
|
/**
|
|
519
|
-
*
|
|
519
|
+
* 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.
|
|
520
520
|
* @summary Replay a delivery
|
|
521
521
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
@@ -561,7 +561,7 @@ export interface AdminWebhooksApiInterface {
|
|
|
561
561
|
*/
|
|
562
562
|
adminWebhooksList(requestParameters: AdminWebhooksApiAdminWebhooksListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminWebhooksListResponse>;
|
|
563
563
|
/**
|
|
564
|
-
* Generates a new HMAC secret and
|
|
564
|
+
* 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.
|
|
565
565
|
* @summary Rotate the signing secret
|
|
566
566
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
567
567
|
* @param {*} [options] Override http request option.
|
|
@@ -570,7 +570,7 @@ export interface AdminWebhooksApiInterface {
|
|
|
570
570
|
*/
|
|
571
571
|
adminWebhooksRotateSecret(requestParameters: AdminWebhooksApiAdminWebhooksRotateSecretRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminWebhooksRotateSecretResponse>;
|
|
572
572
|
/**
|
|
573
|
-
*
|
|
573
|
+
* 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.
|
|
574
574
|
* @summary Send a test delivery
|
|
575
575
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
576
576
|
* @param {*} [options] Override http request option.
|
|
@@ -633,7 +633,7 @@ export interface AdminWebhooksApiInterface {
|
|
|
633
633
|
*/
|
|
634
634
|
patchAdminWebhooksUpdate(requestParameters: AdminWebhooksApiPatchAdminWebhooksUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutAdminWebhooksUpdateResponse>;
|
|
635
635
|
/**
|
|
636
|
-
*
|
|
636
|
+
* 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.
|
|
637
637
|
* @summary Update a webhook
|
|
638
638
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
639
639
|
* @param {*} [options] Override http request option.
|
|
@@ -961,7 +961,7 @@ export interface AdminWebhooksApiPutAdminWebhooksUpdateRequest {
|
|
|
961
961
|
*/
|
|
962
962
|
export declare class AdminWebhooksApi extends BaseAPI implements AdminWebhooksApiInterface {
|
|
963
963
|
/**
|
|
964
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
964
|
+
* 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.
|
|
965
965
|
* @summary Create a webhook
|
|
966
966
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
967
967
|
* @param {*} [options] Override http request option.
|
|
@@ -988,7 +988,7 @@ export declare class AdminWebhooksApi extends BaseAPI implements AdminWebhooksAp
|
|
|
988
988
|
*/
|
|
989
989
|
adminWebhooksDeliveriesList(requestParameters: AdminWebhooksApiAdminWebhooksDeliveriesListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminWebhooksDeliveriesListResponse, any, {}>>;
|
|
990
990
|
/**
|
|
991
|
-
*
|
|
991
|
+
* 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.
|
|
992
992
|
* @summary Replay a delivery
|
|
993
993
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
994
994
|
* @param {*} [options] Override http request option.
|
|
@@ -1033,7 +1033,7 @@ export declare class AdminWebhooksApi extends BaseAPI implements AdminWebhooksAp
|
|
|
1033
1033
|
*/
|
|
1034
1034
|
adminWebhooksList(requestParameters: AdminWebhooksApiAdminWebhooksListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminWebhooksListResponse, any, {}>>;
|
|
1035
1035
|
/**
|
|
1036
|
-
* Generates a new HMAC secret and
|
|
1036
|
+
* 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.
|
|
1037
1037
|
* @summary Rotate the signing secret
|
|
1038
1038
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
1039
1039
|
* @param {*} [options] Override http request option.
|
|
@@ -1042,7 +1042,7 @@ export declare class AdminWebhooksApi extends BaseAPI implements AdminWebhooksAp
|
|
|
1042
1042
|
*/
|
|
1043
1043
|
adminWebhooksRotateSecret(requestParameters: AdminWebhooksApiAdminWebhooksRotateSecretRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminWebhooksRotateSecretResponse, any, {}>>;
|
|
1044
1044
|
/**
|
|
1045
|
-
*
|
|
1045
|
+
* 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.
|
|
1046
1046
|
* @summary Send a test delivery
|
|
1047
1047
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
1048
1048
|
* @param {*} [options] Override http request option.
|
|
@@ -1105,7 +1105,7 @@ export declare class AdminWebhooksApi extends BaseAPI implements AdminWebhooksAp
|
|
|
1105
1105
|
*/
|
|
1106
1106
|
patchAdminWebhooksUpdate(requestParameters: AdminWebhooksApiPatchAdminWebhooksUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PutAdminWebhooksUpdateResponse, any, {}>>;
|
|
1107
1107
|
/**
|
|
1108
|
-
*
|
|
1108
|
+
* 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.
|
|
1109
1109
|
* @summary Update a webhook
|
|
1110
1110
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
1111
1111
|
* @param {*} [options] Override http request option.
|
|
@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
33
33
|
export const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
36
|
+
* 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.
|
|
37
37
|
* @summary Create a webhook
|
|
38
38
|
* @param {string} orgId
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
@@ -143,7 +143,7 @@ export const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
143
143
|
};
|
|
144
144
|
}),
|
|
145
145
|
/**
|
|
146
|
-
*
|
|
146
|
+
* 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.
|
|
147
147
|
* @summary Replay a delivery
|
|
148
148
|
* @param {string} orgId
|
|
149
149
|
* @param {string} webhookId
|
|
@@ -333,7 +333,7 @@ export const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
333
333
|
};
|
|
334
334
|
}),
|
|
335
335
|
/**
|
|
336
|
-
* Generates a new HMAC secret and
|
|
336
|
+
* 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.
|
|
337
337
|
* @summary Rotate the signing secret
|
|
338
338
|
* @param {string} orgId
|
|
339
339
|
* @param {string} webhookId
|
|
@@ -371,7 +371,7 @@ export const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
371
371
|
};
|
|
372
372
|
}),
|
|
373
373
|
/**
|
|
374
|
-
*
|
|
374
|
+
* 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.
|
|
375
375
|
* @summary Send a test delivery
|
|
376
376
|
* @param {string} orgId
|
|
377
377
|
* @param {string} webhookId
|
|
@@ -633,7 +633,7 @@ export const AdminWebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
633
633
|
};
|
|
634
634
|
}),
|
|
635
635
|
/**
|
|
636
|
-
*
|
|
636
|
+
* 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.
|
|
637
637
|
* @summary Update a webhook
|
|
638
638
|
* @param {string} orgId
|
|
639
639
|
* @param {string} webhookId
|
|
@@ -680,7 +680,7 @@ export const AdminWebhooksApiFp = function (configuration) {
|
|
|
680
680
|
const localVarAxiosParamCreator = AdminWebhooksApiAxiosParamCreator(configuration);
|
|
681
681
|
return {
|
|
682
682
|
/**
|
|
683
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
683
|
+
* 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.
|
|
684
684
|
* @summary Create a webhook
|
|
685
685
|
* @param {string} orgId
|
|
686
686
|
* @param {*} [options] Override http request option.
|
|
@@ -730,7 +730,7 @@ export const AdminWebhooksApiFp = function (configuration) {
|
|
|
730
730
|
});
|
|
731
731
|
},
|
|
732
732
|
/**
|
|
733
|
-
*
|
|
733
|
+
* 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.
|
|
734
734
|
* @summary Replay a delivery
|
|
735
735
|
* @param {string} orgId
|
|
736
736
|
* @param {string} webhookId
|
|
@@ -815,7 +815,7 @@ export const AdminWebhooksApiFp = function (configuration) {
|
|
|
815
815
|
});
|
|
816
816
|
},
|
|
817
817
|
/**
|
|
818
|
-
* Generates a new HMAC secret and
|
|
818
|
+
* 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.
|
|
819
819
|
* @summary Rotate the signing secret
|
|
820
820
|
* @param {string} orgId
|
|
821
821
|
* @param {string} webhookId
|
|
@@ -832,7 +832,7 @@ export const AdminWebhooksApiFp = function (configuration) {
|
|
|
832
832
|
});
|
|
833
833
|
},
|
|
834
834
|
/**
|
|
835
|
-
*
|
|
835
|
+
* 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.
|
|
836
836
|
* @summary Send a test delivery
|
|
837
837
|
* @param {string} orgId
|
|
838
838
|
* @param {string} webhookId
|
|
@@ -950,7 +950,7 @@ export const AdminWebhooksApiFp = function (configuration) {
|
|
|
950
950
|
});
|
|
951
951
|
},
|
|
952
952
|
/**
|
|
953
|
-
*
|
|
953
|
+
* 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.
|
|
954
954
|
* @summary Update a webhook
|
|
955
955
|
* @param {string} orgId
|
|
956
956
|
* @param {string} webhookId
|
|
@@ -976,7 +976,7 @@ export const AdminWebhooksApiFactory = function (configuration, basePath, axios)
|
|
|
976
976
|
const localVarFp = AdminWebhooksApiFp(configuration);
|
|
977
977
|
return {
|
|
978
978
|
/**
|
|
979
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
979
|
+
* 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.
|
|
980
980
|
* @summary Create a webhook
|
|
981
981
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
982
982
|
* @param {*} [options] Override http request option.
|
|
@@ -1006,7 +1006,7 @@ export const AdminWebhooksApiFactory = function (configuration, basePath, axios)
|
|
|
1006
1006
|
return localVarFp.adminWebhooksDeliveriesList(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
1007
1007
|
},
|
|
1008
1008
|
/**
|
|
1009
|
-
*
|
|
1009
|
+
* 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.
|
|
1010
1010
|
* @summary Replay a delivery
|
|
1011
1011
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
1012
1012
|
* @param {*} [options] Override http request option.
|
|
@@ -1056,7 +1056,7 @@ export const AdminWebhooksApiFactory = function (configuration, basePath, axios)
|
|
|
1056
1056
|
return localVarFp.adminWebhooksList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1057
1057
|
},
|
|
1058
1058
|
/**
|
|
1059
|
-
* Generates a new HMAC secret and
|
|
1059
|
+
* 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.
|
|
1060
1060
|
* @summary Rotate the signing secret
|
|
1061
1061
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
1062
1062
|
* @param {*} [options] Override http request option.
|
|
@@ -1066,7 +1066,7 @@ export const AdminWebhooksApiFactory = function (configuration, basePath, axios)
|
|
|
1066
1066
|
return localVarFp.adminWebhooksRotateSecret(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
1067
1067
|
},
|
|
1068
1068
|
/**
|
|
1069
|
-
*
|
|
1069
|
+
* 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.
|
|
1070
1070
|
* @summary Send a test delivery
|
|
1071
1071
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
1072
1072
|
* @param {*} [options] Override http request option.
|
|
@@ -1136,7 +1136,7 @@ export const AdminWebhooksApiFactory = function (configuration, basePath, axios)
|
|
|
1136
1136
|
return localVarFp.patchAdminWebhooksUpdate(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(axios, basePath));
|
|
1137
1137
|
},
|
|
1138
1138
|
/**
|
|
1139
|
-
*
|
|
1139
|
+
* 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.
|
|
1140
1140
|
* @summary Update a webhook
|
|
1141
1141
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
1142
1142
|
* @param {*} [options] Override http request option.
|
|
@@ -1155,7 +1155,7 @@ export const AdminWebhooksApiFactory = function (configuration, basePath, axios)
|
|
|
1155
1155
|
*/
|
|
1156
1156
|
export class AdminWebhooksApi extends BaseAPI {
|
|
1157
1157
|
/**
|
|
1158
|
-
* The signing secret is generated server-side and returned once in this response only.
|
|
1158
|
+
* 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.
|
|
1159
1159
|
* @summary Create a webhook
|
|
1160
1160
|
* @param {AdminWebhooksApiAdminWebhooksCreateRequest} requestParameters Request parameters.
|
|
1161
1161
|
* @param {*} [options] Override http request option.
|
|
@@ -1188,7 +1188,7 @@ export class AdminWebhooksApi extends BaseAPI {
|
|
|
1188
1188
|
return AdminWebhooksApiFp(this.configuration).adminWebhooksDeliveriesList(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
1189
1189
|
}
|
|
1190
1190
|
/**
|
|
1191
|
-
*
|
|
1191
|
+
* 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.
|
|
1192
1192
|
* @summary Replay a delivery
|
|
1193
1193
|
* @param {AdminWebhooksApiAdminWebhooksDeliveryReplayRequest} requestParameters Request parameters.
|
|
1194
1194
|
* @param {*} [options] Override http request option.
|
|
@@ -1243,7 +1243,7 @@ export class AdminWebhooksApi extends BaseAPI {
|
|
|
1243
1243
|
return AdminWebhooksApiFp(this.configuration).adminWebhooksList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1244
1244
|
}
|
|
1245
1245
|
/**
|
|
1246
|
-
* Generates a new HMAC secret and
|
|
1246
|
+
* 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.
|
|
1247
1247
|
* @summary Rotate the signing secret
|
|
1248
1248
|
* @param {AdminWebhooksApiAdminWebhooksRotateSecretRequest} requestParameters Request parameters.
|
|
1249
1249
|
* @param {*} [options] Override http request option.
|
|
@@ -1254,7 +1254,7 @@ export class AdminWebhooksApi extends BaseAPI {
|
|
|
1254
1254
|
return AdminWebhooksApiFp(this.configuration).adminWebhooksRotateSecret(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
1255
1255
|
}
|
|
1256
1256
|
/**
|
|
1257
|
-
*
|
|
1257
|
+
* 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.
|
|
1258
1258
|
* @summary Send a test delivery
|
|
1259
1259
|
* @param {AdminWebhooksApiAdminWebhooksTestRequest} requestParameters Request parameters.
|
|
1260
1260
|
* @param {*} [options] Override http request option.
|
|
@@ -1331,7 +1331,7 @@ export class AdminWebhooksApi extends BaseAPI {
|
|
|
1331
1331
|
return AdminWebhooksApiFp(this.configuration).patchAdminWebhooksUpdate(requestParameters.orgId, requestParameters.webhookId, options).then((request) => request(this.axios, this.basePath));
|
|
1332
1332
|
}
|
|
1333
1333
|
/**
|
|
1334
|
-
*
|
|
1334
|
+
* 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.
|
|
1335
1335
|
* @summary Update a webhook
|
|
1336
1336
|
* @param {AdminWebhooksApiPutAdminWebhooksUpdateRequest} requestParameters Request parameters.
|
|
1337
1337
|
* @param {*} [options] Override http request option.
|