@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
|
@@ -22,7 +22,7 @@ import type { MessageResponse } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const AdminMcpApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
* Body:
|
|
25
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
26
26
|
* @summary Register an MCP server
|
|
27
27
|
* @param {string} orgId
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -62,7 +62,7 @@ export declare const AdminMcpApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
62
62
|
*/
|
|
63
63
|
export declare const AdminMcpApiFp: (configuration?: Configuration) => {
|
|
64
64
|
/**
|
|
65
|
-
* Body:
|
|
65
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
66
66
|
* @summary Register an MCP server
|
|
67
67
|
* @param {string} orgId
|
|
68
68
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +102,7 @@ export declare const AdminMcpApiFp: (configuration?: Configuration) => {
|
|
|
102
102
|
*/
|
|
103
103
|
export declare const AdminMcpApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
104
104
|
/**
|
|
105
|
-
* Body:
|
|
105
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
106
106
|
* @summary Register an MCP server
|
|
107
107
|
* @param {AdminMcpApiAdminMcpServersCreateRequest} requestParameters Request parameters.
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
@@ -141,7 +141,7 @@ export declare const AdminMcpApiFactory: (configuration?: Configuration, basePat
|
|
|
141
141
|
*/
|
|
142
142
|
export interface AdminMcpApiInterface {
|
|
143
143
|
/**
|
|
144
|
-
* Body:
|
|
144
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
145
145
|
* @summary Register an MCP server
|
|
146
146
|
* @param {AdminMcpApiAdminMcpServersCreateRequest} requestParameters Request parameters.
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
@@ -249,7 +249,7 @@ export interface AdminMcpApiAdminMcpServersListRequest {
|
|
|
249
249
|
*/
|
|
250
250
|
export declare class AdminMcpApi extends BaseAPI implements AdminMcpApiInterface {
|
|
251
251
|
/**
|
|
252
|
-
* Body:
|
|
252
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
253
253
|
* @summary Register an MCP server
|
|
254
254
|
* @param {AdminMcpApiAdminMcpServersCreateRequest} requestParameters Request parameters.
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
33
33
|
export const AdminMcpApiAxiosParamCreator = function (configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Body:
|
|
36
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
37
37
|
* @summary Register an MCP server
|
|
38
38
|
* @param {string} orgId
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
@@ -186,7 +186,7 @@ export const AdminMcpApiFp = function (configuration) {
|
|
|
186
186
|
const localVarAxiosParamCreator = AdminMcpApiAxiosParamCreator(configuration);
|
|
187
187
|
return {
|
|
188
188
|
/**
|
|
189
|
-
* Body:
|
|
189
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
190
190
|
* @summary Register an MCP server
|
|
191
191
|
* @param {string} orgId
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
@@ -261,7 +261,7 @@ export const AdminMcpApiFactory = function (configuration, basePath, axios) {
|
|
|
261
261
|
const localVarFp = AdminMcpApiFp(configuration);
|
|
262
262
|
return {
|
|
263
263
|
/**
|
|
264
|
-
* Body:
|
|
264
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
265
265
|
* @summary Register an MCP server
|
|
266
266
|
* @param {AdminMcpApiAdminMcpServersCreateRequest} requestParameters Request parameters.
|
|
267
267
|
* @param {*} [options] Override http request option.
|
|
@@ -310,7 +310,7 @@ export const AdminMcpApiFactory = function (configuration, basePath, axios) {
|
|
|
310
310
|
*/
|
|
311
311
|
export class AdminMcpApi extends BaseAPI {
|
|
312
312
|
/**
|
|
313
|
-
* Body:
|
|
313
|
+
* Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
314
314
|
* @summary Register an MCP server
|
|
315
315
|
* @param {AdminMcpApiAdminMcpServersCreateRequest} requestParameters Request parameters.
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
@@ -160,7 +160,7 @@ export declare const AdminOAuthClientsApiAxiosParamCreator: (configuration?: Con
|
|
|
160
160
|
setClientScopes: (orgId: string, clientId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
161
161
|
/**
|
|
162
162
|
*
|
|
163
|
-
* @summary
|
|
163
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
164
164
|
* @param {string} orgId
|
|
165
165
|
* @param {string} clientId
|
|
166
166
|
* @param {*} [options] Override http request option.
|
|
@@ -301,7 +301,7 @@ export declare const AdminOAuthClientsApiFp: (configuration?: Configuration) =>
|
|
|
301
301
|
setClientScopes(orgId: string, clientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetClientScopesResponse>>;
|
|
302
302
|
/**
|
|
303
303
|
*
|
|
304
|
-
* @summary
|
|
304
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
305
305
|
* @param {string} orgId
|
|
306
306
|
* @param {string} clientId
|
|
307
307
|
* @param {*} [options] Override http request option.
|
|
@@ -428,7 +428,7 @@ export declare const AdminOAuthClientsApiFactory: (configuration?: Configuration
|
|
|
428
428
|
setClientScopes(requestParameters: AdminOAuthClientsApiSetClientScopesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetClientScopesResponse>;
|
|
429
429
|
/**
|
|
430
430
|
*
|
|
431
|
-
* @summary
|
|
431
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
432
432
|
* @param {AdminOAuthClientsApiUpdateClientRequest} requestParameters Request parameters.
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
@@ -569,7 +569,7 @@ export interface AdminOAuthClientsApiInterface {
|
|
|
569
569
|
setClientScopes(requestParameters: AdminOAuthClientsApiSetClientScopesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetClientScopesResponse>;
|
|
570
570
|
/**
|
|
571
571
|
*
|
|
572
|
-
* @summary
|
|
572
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
573
573
|
* @param {AdminOAuthClientsApiUpdateClientRequest} requestParameters Request parameters.
|
|
574
574
|
* @param {*} [options] Override http request option.
|
|
575
575
|
* @throws {RequiredError}
|
|
@@ -997,7 +997,7 @@ export declare class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthC
|
|
|
997
997
|
setClientScopes(requestParameters: AdminOAuthClientsApiSetClientScopesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SetClientScopesResponse, any, {}>>;
|
|
998
998
|
/**
|
|
999
999
|
*
|
|
1000
|
-
* @summary
|
|
1000
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
1001
1001
|
* @param {AdminOAuthClientsApiUpdateClientRequest} requestParameters Request parameters.
|
|
1002
1002
|
* @param {*} [options] Override http request option.
|
|
1003
1003
|
* @throws {RequiredError}
|
|
@@ -565,7 +565,7 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
|
|
|
565
565
|
}),
|
|
566
566
|
/**
|
|
567
567
|
*
|
|
568
|
-
* @summary
|
|
568
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
569
569
|
* @param {string} orgId
|
|
570
570
|
* @param {string} clientId
|
|
571
571
|
* @param {*} [options] Override http request option.
|
|
@@ -850,7 +850,7 @@ export const AdminOAuthClientsApiFp = function (configuration) {
|
|
|
850
850
|
},
|
|
851
851
|
/**
|
|
852
852
|
*
|
|
853
|
-
* @summary
|
|
853
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
854
854
|
* @param {string} orgId
|
|
855
855
|
* @param {string} clientId
|
|
856
856
|
* @param {*} [options] Override http request option.
|
|
@@ -1016,7 +1016,7 @@ export const AdminOAuthClientsApiFactory = function (configuration, basePath, ax
|
|
|
1016
1016
|
},
|
|
1017
1017
|
/**
|
|
1018
1018
|
*
|
|
1019
|
-
* @summary
|
|
1019
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
1020
1020
|
* @param {AdminOAuthClientsApiUpdateClientRequest} requestParameters Request parameters.
|
|
1021
1021
|
* @param {*} [options] Override http request option.
|
|
1022
1022
|
* @throws {RequiredError}
|
|
@@ -1189,7 +1189,7 @@ export class AdminOAuthClientsApi extends BaseAPI {
|
|
|
1189
1189
|
}
|
|
1190
1190
|
/**
|
|
1191
1191
|
*
|
|
1192
|
-
* @summary
|
|
1192
|
+
* @summary Update an OAuth client (same as PATCH: only the fields that are sent change)
|
|
1193
1193
|
* @param {AdminOAuthClientsApiUpdateClientRequest} requestParameters Request parameters.
|
|
1194
1194
|
* @param {*} [options] Override http request option.
|
|
1195
1195
|
* @throws {RequiredError}
|
|
@@ -39,7 +39,7 @@ export declare const AdminSandboxApiAxiosParamCreator: (configuration?: Configur
|
|
|
39
39
|
*/
|
|
40
40
|
adminSandboxList: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
43
43
|
* @summary Spawn a sandbox tenant
|
|
44
44
|
* @param {string} orgId
|
|
45
45
|
* @param {AdminSandboxSpawnRequest} [adminSandboxSpawnRequest]
|
|
@@ -71,7 +71,7 @@ export declare const AdminSandboxApiFp: (configuration?: Configuration) => {
|
|
|
71
71
|
*/
|
|
72
72
|
adminSandboxList(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminSandboxListResponse>>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
75
75
|
* @summary Spawn a sandbox tenant
|
|
76
76
|
* @param {string} orgId
|
|
77
77
|
* @param {AdminSandboxSpawnRequest} [adminSandboxSpawnRequest]
|
|
@@ -102,7 +102,7 @@ export declare const AdminSandboxApiFactory: (configuration?: Configuration, bas
|
|
|
102
102
|
*/
|
|
103
103
|
adminSandboxList(requestParameters: AdminSandboxApiAdminSandboxListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminSandboxListResponse>;
|
|
104
104
|
/**
|
|
105
|
-
*
|
|
105
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
106
106
|
* @summary Spawn a sandbox tenant
|
|
107
107
|
* @param {AdminSandboxApiAdminSandboxSpawnRequest} requestParameters Request parameters.
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
@@ -135,7 +135,7 @@ export interface AdminSandboxApiInterface {
|
|
|
135
135
|
*/
|
|
136
136
|
adminSandboxList(requestParameters: AdminSandboxApiAdminSandboxListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminSandboxListResponse>;
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
138
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
139
139
|
* @summary Spawn a sandbox tenant
|
|
140
140
|
* @param {AdminSandboxApiAdminSandboxSpawnRequest} requestParameters Request parameters.
|
|
141
141
|
* @param {*} [options] Override http request option.
|
|
@@ -221,7 +221,7 @@ export declare class AdminSandboxApi extends BaseAPI implements AdminSandboxApiI
|
|
|
221
221
|
*/
|
|
222
222
|
adminSandboxList(requestParameters: AdminSandboxApiAdminSandboxListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminSandboxListResponse, any, {}>>;
|
|
223
223
|
/**
|
|
224
|
-
*
|
|
224
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
225
225
|
* @summary Spawn a sandbox tenant
|
|
226
226
|
* @param {AdminSandboxApiAdminSandboxSpawnRequest} requestParameters Request parameters.
|
|
227
227
|
* @param {*} [options] Override http request option.
|
|
@@ -105,7 +105,7 @@ export const AdminSandboxApiAxiosParamCreator = function (configuration) {
|
|
|
105
105
|
};
|
|
106
106
|
}),
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
109
109
|
* @summary Spawn a sandbox tenant
|
|
110
110
|
* @param {string} orgId
|
|
111
111
|
* @param {AdminSandboxSpawnRequest} [adminSandboxSpawnRequest]
|
|
@@ -184,7 +184,7 @@ export const AdminSandboxApiFp = function (configuration) {
|
|
|
184
184
|
});
|
|
185
185
|
},
|
|
186
186
|
/**
|
|
187
|
-
*
|
|
187
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
188
188
|
* @summary Spawn a sandbox tenant
|
|
189
189
|
* @param {string} orgId
|
|
190
190
|
* @param {AdminSandboxSpawnRequest} [adminSandboxSpawnRequest]
|
|
@@ -230,7 +230,7 @@ export const AdminSandboxApiFactory = function (configuration, basePath, axios)
|
|
|
230
230
|
return localVarFp.adminSandboxList(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
231
231
|
},
|
|
232
232
|
/**
|
|
233
|
-
*
|
|
233
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
234
234
|
* @summary Spawn a sandbox tenant
|
|
235
235
|
* @param {AdminSandboxApiAdminSandboxSpawnRequest} requestParameters Request parameters.
|
|
236
236
|
* @param {*} [options] Override http request option.
|
|
@@ -271,7 +271,7 @@ export class AdminSandboxApi extends BaseAPI {
|
|
|
271
271
|
return AdminSandboxApiFp(this.configuration).adminSandboxList(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
*
|
|
274
|
+
* Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
275
275
|
* @summary Spawn a sandbox tenant
|
|
276
276
|
* @param {AdminSandboxApiAdminSandboxSpawnRequest} requestParameters Request parameters.
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
@@ -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
|
}
|