@lumoauth/api-client 1.3.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 +22 -0
- package/README.md +19 -5
- package/api/admin-agents-api.ts +166 -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/agents-api.ts +118 -0
- package/api/oauth-api.ts +111 -0
- package/dist/api/admin-agents-api.d.ts +94 -4
- package/dist/api/admin-agents-api.js +100 -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/agents-api.d.ts +65 -0
- package/dist/api/agents-api.js +77 -0
- 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 +94 -4
- package/dist/esm/api/admin-agents-api.js +100 -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/agents-api.d.ts +65 -0
- package/dist/esm/api/agents-api.js +77 -0
- package/dist/esm/api/oauth-api.d.ts +65 -0
- package/dist/esm/api/oauth-api.js +73 -1
- package/dist/esm/models/abac-attribute-definition.d.ts +1 -1
- package/dist/esm/models/abac-resource-attribute.d.ts +1 -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-agents-report-usage-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-request.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/esm/models/admin-agents-report-usage-response-data-recorded.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/esm/models/admin-agents-report-usage-response-data.js +14 -0
- package/dist/esm/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/esm/models/admin-agents-report-usage-response.js +14 -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 +11 -0
- package/dist/esm/models/index.js +11 -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/report-agent-usage-response.d.ts +33 -0
- package/dist/esm/models/report-agent-usage-response.js +14 -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/esm/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/esm/models/userinfo-response.d.ts +8 -0
- package/dist/models/abac-attribute-definition.d.ts +1 -1
- package/dist/models/abac-resource-attribute.d.ts +1 -1
- 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-agents-report-usage-request.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-request.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.d.ts +30 -0
- package/dist/models/admin-agents-report-usage-response-data-recorded.js +15 -0
- package/dist/models/admin-agents-report-usage-response-data.d.ts +33 -0
- package/dist/models/admin-agents-report-usage-response-data.js +15 -0
- package/dist/models/admin-agents-report-usage-response.d.ts +25 -0
- package/dist/models/admin-agents-report-usage-response.js +15 -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 +11 -0
- package/dist/models/index.js +11 -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/report-agent-usage-response.d.ts +33 -0
- package/dist/models/report-agent-usage-response.js +15 -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/dist/models/set-user-attribute-response-data.d.ts +1 -1
- package/dist/models/userinfo-response.d.ts +8 -0
- 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 +83 -8
- package/docs/AdminAgentsCreateRequest.md +2 -0
- package/docs/AdminAgentsReportUsageRequest.md +22 -0
- package/docs/AdminAgentsReportUsageResponse.md +20 -0
- package/docs/AdminAgentsReportUsageResponseData.md +22 -0
- package/docs/AdminAgentsReportUsageResponseDataRecorded.md +22 -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 +64 -2
- 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/OIDCApi.md +2 -2
- package/docs/PushEnrollmentStarted.md +1 -1
- package/docs/PutAdminAgentsUpdateRequest.md +2 -0
- package/docs/ReportAgentUsageResponse.md +22 -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/docs/UserinfoResponse.md +2 -0
- package/models/abac-attribute-definition.ts +1 -1
- package/models/abac-resource-attribute.ts +1 -1
- 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-agents-report-usage-request.ts +36 -0
- package/models/admin-agents-report-usage-response-data-recorded.ts +36 -0
- package/models/admin-agents-report-usage-response-data.ts +39 -0
- package/models/admin-agents-report-usage-response.ts +33 -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 +11 -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/report-agent-usage-response.ts +39 -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/models/set-user-attribute-response-data.ts +1 -1
- package/models/userinfo-response.ts +6 -0
- package/package.json +1 -1
|
@@ -90,8 +90,8 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
90
90
|
*/
|
|
91
91
|
adminIdentitiesLegacySamlReport: (orgId: string, idpId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
92
|
/**
|
|
93
|
-
* 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).
|
|
94
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
93
|
+
* 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).
|
|
94
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
95
95
|
* @param {string} orgId
|
|
96
96
|
* @param {string} userId
|
|
97
97
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -100,7 +100,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
100
100
|
*/
|
|
101
101
|
adminIdentitiesLink: (orgId: string, userId: string, adminIdentitiesLinkRequest: AdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
102
|
/**
|
|
103
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
103
|
+
* 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.
|
|
104
104
|
* @summary List a user\'s federated identity links
|
|
105
105
|
* @param {string} orgId
|
|
106
106
|
* @param {string} userId
|
|
@@ -109,8 +109,8 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
109
109
|
*/
|
|
110
110
|
adminIdentitiesList: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
111
|
/**
|
|
112
|
-
* 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.
|
|
113
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
112
|
+
* 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.
|
|
113
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
114
114
|
* @param {AdminIdentitiesUnlinkType} type
|
|
115
115
|
* @param {string} orgId
|
|
116
116
|
* @param {string} userId
|
|
@@ -370,8 +370,8 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
370
370
|
*/
|
|
371
371
|
adminIdentitiesLegacySamlReport(orgId: string, idpId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminIdentitiesLegacySamlReportResponse>>;
|
|
372
372
|
/**
|
|
373
|
-
* 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).
|
|
374
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
373
|
+
* 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).
|
|
374
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
375
375
|
* @param {string} orgId
|
|
376
376
|
* @param {string} userId
|
|
377
377
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -380,7 +380,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
380
380
|
*/
|
|
381
381
|
adminIdentitiesLink(orgId: string, userId: string, adminIdentitiesLinkRequest: AdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsGetResponse>>;
|
|
382
382
|
/**
|
|
383
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
383
|
+
* 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.
|
|
384
384
|
* @summary List a user\'s federated identity links
|
|
385
385
|
* @param {string} orgId
|
|
386
386
|
* @param {string} userId
|
|
@@ -389,8 +389,8 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
389
389
|
*/
|
|
390
390
|
adminIdentitiesList(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminIdentitiesListResponse>>;
|
|
391
391
|
/**
|
|
392
|
-
* 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.
|
|
393
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
392
|
+
* 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.
|
|
393
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
394
394
|
* @param {AdminIdentitiesUnlinkType} type
|
|
395
395
|
* @param {string} orgId
|
|
396
396
|
* @param {string} userId
|
|
@@ -645,15 +645,15 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
645
645
|
*/
|
|
646
646
|
adminIdentitiesLegacySamlReport(requestParameters: AdminUsersApiAdminIdentitiesLegacySamlReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesLegacySamlReportResponse>;
|
|
647
647
|
/**
|
|
648
|
-
* 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).
|
|
649
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
648
|
+
* 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).
|
|
649
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
650
650
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
651
651
|
* @param {*} [options] Override http request option.
|
|
652
652
|
* @throws {RequiredError}
|
|
653
653
|
*/
|
|
654
654
|
adminIdentitiesLink(requestParameters: AdminUsersApiAdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
655
655
|
/**
|
|
656
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
656
|
+
* 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.
|
|
657
657
|
* @summary List a user\'s federated identity links
|
|
658
658
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
659
659
|
* @param {*} [options] Override http request option.
|
|
@@ -661,8 +661,8 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
661
661
|
*/
|
|
662
662
|
adminIdentitiesList(requestParameters: AdminUsersApiAdminIdentitiesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesListResponse>;
|
|
663
663
|
/**
|
|
664
|
-
* 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.
|
|
665
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
664
|
+
* 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.
|
|
665
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
666
666
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
667
667
|
* @param {*} [options] Override http request option.
|
|
668
668
|
* @throws {RequiredError}
|
|
@@ -898,8 +898,8 @@ export interface AdminUsersApiInterface {
|
|
|
898
898
|
*/
|
|
899
899
|
adminIdentitiesLegacySamlReport(requestParameters: AdminUsersApiAdminIdentitiesLegacySamlReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesLegacySamlReportResponse>;
|
|
900
900
|
/**
|
|
901
|
-
* 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).
|
|
902
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
901
|
+
* 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).
|
|
902
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
903
903
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
904
904
|
* @param {*} [options] Override http request option.
|
|
905
905
|
* @throws {RequiredError}
|
|
@@ -907,7 +907,7 @@ export interface AdminUsersApiInterface {
|
|
|
907
907
|
*/
|
|
908
908
|
adminIdentitiesLink(requestParameters: AdminUsersApiAdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
909
909
|
/**
|
|
910
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
910
|
+
* 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.
|
|
911
911
|
* @summary List a user\'s federated identity links
|
|
912
912
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
913
913
|
* @param {*} [options] Override http request option.
|
|
@@ -916,8 +916,8 @@ export interface AdminUsersApiInterface {
|
|
|
916
916
|
*/
|
|
917
917
|
adminIdentitiesList(requestParameters: AdminUsersApiAdminIdentitiesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesListResponse>;
|
|
918
918
|
/**
|
|
919
|
-
* 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.
|
|
920
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
919
|
+
* 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.
|
|
920
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
921
921
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
922
922
|
* @param {*} [options] Override http request option.
|
|
923
923
|
* @throws {RequiredError}
|
|
@@ -1271,7 +1271,7 @@ export interface AdminUsersApiAdminIdentitiesListRequest {
|
|
|
1271
1271
|
export interface AdminUsersApiAdminIdentitiesUnlinkRequest {
|
|
1272
1272
|
/**
|
|
1273
1273
|
*
|
|
1274
|
-
* @type {'saml' | 'ldap' | 'social'}
|
|
1274
|
+
* @type {'saml' | 'oidc' | 'ldap' | 'social'}
|
|
1275
1275
|
* @memberof AdminUsersApiAdminIdentitiesUnlink
|
|
1276
1276
|
*/
|
|
1277
1277
|
readonly type: AdminIdentitiesUnlinkType;
|
|
@@ -1765,8 +1765,8 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1765
1765
|
*/
|
|
1766
1766
|
adminIdentitiesLegacySamlReport(requestParameters: AdminUsersApiAdminIdentitiesLegacySamlReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminIdentitiesLegacySamlReportResponse, any, {}>>;
|
|
1767
1767
|
/**
|
|
1768
|
-
* 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).
|
|
1769
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1768
|
+
* 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).
|
|
1769
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1770
1770
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
1771
1771
|
* @param {*} [options] Override http request option.
|
|
1772
1772
|
* @throws {RequiredError}
|
|
@@ -1774,7 +1774,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1774
1774
|
*/
|
|
1775
1775
|
adminIdentitiesLink(requestParameters: AdminUsersApiAdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAgentsGetResponse, any, {}>>;
|
|
1776
1776
|
/**
|
|
1777
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1777
|
+
* 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.
|
|
1778
1778
|
* @summary List a user\'s federated identity links
|
|
1779
1779
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
1780
1780
|
* @param {*} [options] Override http request option.
|
|
@@ -1783,8 +1783,8 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
adminIdentitiesList(requestParameters: AdminUsersApiAdminIdentitiesListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminIdentitiesListResponse, any, {}>>;
|
|
1785
1785
|
/**
|
|
1786
|
-
* 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.
|
|
1787
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1786
|
+
* 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.
|
|
1787
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1788
1788
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
1789
1789
|
* @param {*} [options] Override http request option.
|
|
1790
1790
|
* @throws {RequiredError}
|
|
@@ -1997,6 +1997,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1997
1997
|
*/
|
|
1998
1998
|
export declare enum AdminIdentitiesUnlinkType {
|
|
1999
1999
|
SAML = "saml",
|
|
2000
|
+
OIDC = "oidc",
|
|
2000
2001
|
LDAP = "ldap",
|
|
2001
2002
|
SOCIAL = "social"
|
|
2002
2003
|
}
|
|
@@ -227,8 +227,8 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
227
227
|
};
|
|
228
228
|
}),
|
|
229
229
|
/**
|
|
230
|
-
* 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).
|
|
231
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
230
|
+
* 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).
|
|
231
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
232
232
|
* @param {string} orgId
|
|
233
233
|
* @param {string} userId
|
|
234
234
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -270,7 +270,7 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
270
270
|
};
|
|
271
271
|
}),
|
|
272
272
|
/**
|
|
273
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
273
|
+
* 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.
|
|
274
274
|
* @summary List a user\'s federated identity links
|
|
275
275
|
* @param {string} orgId
|
|
276
276
|
* @param {string} userId
|
|
@@ -308,8 +308,8 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
308
308
|
};
|
|
309
309
|
}),
|
|
310
310
|
/**
|
|
311
|
-
* 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.
|
|
312
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
311
|
+
* 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.
|
|
312
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
313
313
|
* @param {AdminIdentitiesUnlinkType} type
|
|
314
314
|
* @param {string} orgId
|
|
315
315
|
* @param {string} userId
|
|
@@ -1286,8 +1286,8 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1286
1286
|
});
|
|
1287
1287
|
},
|
|
1288
1288
|
/**
|
|
1289
|
-
* 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).
|
|
1290
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1289
|
+
* 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).
|
|
1290
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1291
1291
|
* @param {string} orgId
|
|
1292
1292
|
* @param {string} userId
|
|
1293
1293
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -1304,7 +1304,7 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1304
1304
|
});
|
|
1305
1305
|
},
|
|
1306
1306
|
/**
|
|
1307
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1307
|
+
* 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.
|
|
1308
1308
|
* @summary List a user\'s federated identity links
|
|
1309
1309
|
* @param {string} orgId
|
|
1310
1310
|
* @param {string} userId
|
|
@@ -1321,8 +1321,8 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1321
1321
|
});
|
|
1322
1322
|
},
|
|
1323
1323
|
/**
|
|
1324
|
-
* 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.
|
|
1325
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1324
|
+
* 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.
|
|
1325
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1326
1326
|
* @param {AdminIdentitiesUnlinkType} type
|
|
1327
1327
|
* @param {string} orgId
|
|
1328
1328
|
* @param {string} userId
|
|
@@ -1775,8 +1775,8 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1775
1775
|
return localVarFp.adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(axios, basePath));
|
|
1776
1776
|
},
|
|
1777
1777
|
/**
|
|
1778
|
-
* 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).
|
|
1779
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1778
|
+
* 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).
|
|
1779
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1780
1780
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
1781
1781
|
* @param {*} [options] Override http request option.
|
|
1782
1782
|
* @throws {RequiredError}
|
|
@@ -1785,7 +1785,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1785
1785
|
return localVarFp.adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(axios, basePath));
|
|
1786
1786
|
},
|
|
1787
1787
|
/**
|
|
1788
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1788
|
+
* 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.
|
|
1789
1789
|
* @summary List a user\'s federated identity links
|
|
1790
1790
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
1791
1791
|
* @param {*} [options] Override http request option.
|
|
@@ -1795,8 +1795,8 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1795
1795
|
return localVarFp.adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1796
1796
|
},
|
|
1797
1797
|
/**
|
|
1798
|
-
* 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.
|
|
1799
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1798
|
+
* 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.
|
|
1799
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1800
1800
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
1801
1801
|
* @param {*} [options] Override http request option.
|
|
1802
1802
|
* @throws {RequiredError}
|
|
@@ -2091,8 +2091,8 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2091
2091
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(this.axios, this.basePath));
|
|
2092
2092
|
}
|
|
2093
2093
|
/**
|
|
2094
|
-
* 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).
|
|
2095
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
2094
|
+
* 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).
|
|
2095
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
2096
2096
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
2097
2097
|
* @param {*} [options] Override http request option.
|
|
2098
2098
|
* @throws {RequiredError}
|
|
@@ -2102,7 +2102,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2102
2102
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2103
2103
|
}
|
|
2104
2104
|
/**
|
|
2105
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
2105
|
+
* 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.
|
|
2106
2106
|
* @summary List a user\'s federated identity links
|
|
2107
2107
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
2108
2108
|
* @param {*} [options] Override http request option.
|
|
@@ -2113,8 +2113,8 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2113
2113
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2114
2114
|
}
|
|
2115
2115
|
/**
|
|
2116
|
-
* 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.
|
|
2117
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
2116
|
+
* 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.
|
|
2117
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
2118
2118
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
2119
2119
|
* @param {*} [options] Override http request option.
|
|
2120
2120
|
* @throws {RequiredError}
|
|
@@ -2375,6 +2375,7 @@ exports.AdminUsersApi = AdminUsersApi;
|
|
|
2375
2375
|
var AdminIdentitiesUnlinkType;
|
|
2376
2376
|
(function (AdminIdentitiesUnlinkType) {
|
|
2377
2377
|
AdminIdentitiesUnlinkType["SAML"] = "saml";
|
|
2378
|
+
AdminIdentitiesUnlinkType["OIDC"] = "oidc";
|
|
2378
2379
|
AdminIdentitiesUnlinkType["LDAP"] = "ldap";
|
|
2379
2380
|
AdminIdentitiesUnlinkType["SOCIAL"] = "social";
|
|
2380
2381
|
})(AdminIdentitiesUnlinkType || (exports.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.
|