auth0 4.0.0-beta.0 → 4.0.0-beta.10
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/README.md +17 -9
- package/dist/cjs/auth/base-auth-api.d.ts +39 -0
- package/dist/cjs/auth/base-auth-api.js +103 -0
- package/dist/cjs/auth/base-auth-api.js.map +1 -0
- package/dist/cjs/auth/client-authentication.d.ts +26 -0
- package/dist/cjs/auth/client-authentication.js +63 -0
- package/dist/cjs/auth/client-authentication.js.map +1 -0
- package/dist/cjs/auth/database.d.ts +157 -0
- package/dist/cjs/auth/database.js +73 -0
- package/dist/cjs/auth/database.js.map +1 -0
- package/dist/cjs/auth/id-token-validator.d.ts +18 -0
- package/dist/cjs/auth/id-token-validator.js +145 -0
- package/dist/cjs/auth/id-token-validator.js.map +1 -0
- package/dist/cjs/auth/index.d.ts +15 -0
- package/dist/cjs/auth/index.js +36 -0
- package/dist/cjs/auth/index.js.map +1 -0
- package/dist/cjs/auth/oauth.d.ts +297 -0
- package/dist/cjs/auth/oauth.js +172 -0
- package/dist/cjs/auth/oauth.js.map +1 -0
- package/dist/cjs/auth/passwordless.d.ts +165 -0
- package/dist/cjs/auth/passwordless.js +162 -0
- package/dist/cjs/auth/passwordless.js.map +1 -0
- package/dist/cjs/index.d.ts +4 -0
- package/dist/cjs/index.js +21 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/lib/errors.d.ts +33 -0
- package/dist/cjs/lib/errors.js +49 -0
- package/dist/cjs/lib/errors.js.map +1 -0
- package/dist/cjs/lib/index.d.ts +3 -0
- package/dist/cjs/lib/index.js +19 -0
- package/dist/cjs/lib/index.js.map +1 -0
- package/dist/cjs/lib/middleware/telemetry-middleware.d.ts +12 -0
- package/dist/cjs/lib/middleware/telemetry-middleware.js +27 -0
- package/dist/cjs/lib/middleware/telemetry-middleware.js.map +1 -0
- package/dist/cjs/lib/models.d.ts +123 -0
- package/dist/cjs/lib/models.js +41 -0
- package/dist/cjs/lib/models.js.map +1 -0
- package/dist/cjs/lib/retry.d.ts +26 -0
- package/dist/cjs/lib/retry.js +53 -0
- package/dist/cjs/lib/retry.js.map +1 -0
- package/dist/cjs/lib/runtime.d.ts +61 -0
- package/dist/cjs/lib/runtime.js +228 -0
- package/dist/cjs/lib/runtime.js.map +1 -0
- package/dist/cjs/management/__generated/index.d.ts +39 -0
- package/dist/cjs/management/__generated/index.js +58 -0
- package/dist/cjs/management/__generated/index.js.map +1 -0
- package/dist/cjs/management/__generated/managers/actions-manager.d.ts +136 -0
- package/dist/cjs/management/__generated/managers/actions-manager.js +336 -0
- package/dist/cjs/management/__generated/managers/actions-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/anomaly-manager.d.ts +24 -0
- package/dist/cjs/management/__generated/managers/anomaly-manager.js +63 -0
- package/dist/cjs/management/__generated/managers/anomaly-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/attack-protection-manager.d.ts +46 -0
- package/dist/cjs/management/__generated/managers/attack-protection-manager.js +119 -0
- package/dist/cjs/management/__generated/managers/attack-protection-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/blacklists-manager.d.ts +28 -0
- package/dist/cjs/management/__generated/managers/blacklists-manager.js +76 -0
- package/dist/cjs/management/__generated/managers/blacklists-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/branding-manager.d.ts +103 -0
- package/dist/cjs/management/__generated/managers/branding-manager.js +207 -0
- package/dist/cjs/management/__generated/managers/branding-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/client-grants-manager.d.ts +42 -0
- package/dist/cjs/management/__generated/managers/client-grants-manager.js +114 -0
- package/dist/cjs/management/__generated/managers/client-grants-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/clients-manager.d.ts +177 -0
- package/dist/cjs/management/__generated/managers/clients-manager.js +305 -0
- package/dist/cjs/management/__generated/managers/clients-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/connections-manager.d.ts +84 -0
- package/dist/cjs/management/__generated/managers/connections-manager.js +198 -0
- package/dist/cjs/management/__generated/managers/connections-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/custom-domains-manager.d.ts +106 -0
- package/dist/cjs/management/__generated/managers/custom-domains-manager.js +179 -0
- package/dist/cjs/management/__generated/managers/custom-domains-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/device-credentials-manager.d.ts +42 -0
- package/dist/cjs/management/__generated/managers/device-credentials-manager.js +112 -0
- package/dist/cjs/management/__generated/managers/device-credentials-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/email-templates-manager.d.ts +38 -0
- package/dist/cjs/management/__generated/managers/email-templates-manager.js +102 -0
- package/dist/cjs/management/__generated/managers/email-templates-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/emails-manager.d.ts +40 -0
- package/dist/cjs/management/__generated/managers/emails-manager.js +102 -0
- package/dist/cjs/management/__generated/managers/emails-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/grants-manager.d.ts +34 -0
- package/dist/cjs/management/__generated/managers/grants-manager.js +104 -0
- package/dist/cjs/management/__generated/managers/grants-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/guardian-manager.d.ts +240 -0
- package/dist/cjs/management/__generated/managers/guardian-manager.js +520 -0
- package/dist/cjs/management/__generated/managers/guardian-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/hooks-manager.d.ts +90 -0
- package/dist/cjs/management/__generated/managers/hooks-manager.js +214 -0
- package/dist/cjs/management/__generated/managers/hooks-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/index.d.ts +31 -0
- package/dist/cjs/management/__generated/managers/index.js +48 -0
- package/dist/cjs/management/__generated/managers/index.js.map +1 -0
- package/dist/cjs/management/__generated/managers/jobs-manager.d.ts +47 -0
- package/dist/cjs/management/__generated/managers/jobs-manager.js +131 -0
- package/dist/cjs/management/__generated/managers/jobs-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/keys-manager.d.ts +34 -0
- package/dist/cjs/management/__generated/managers/keys-manager.js +85 -0
- package/dist/cjs/management/__generated/managers/keys-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/log-streams-manager.d.ts +326 -0
- package/dist/cjs/management/__generated/managers/log-streams-manager.js +392 -0
- package/dist/cjs/management/__generated/managers/log-streams-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/logs-manager.d.ts +56 -0
- package/dist/cjs/management/__generated/managers/logs-manager.js +95 -0
- package/dist/cjs/management/__generated/managers/logs-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/organizations-manager.d.ts +191 -0
- package/dist/cjs/management/__generated/managers/organizations-manager.js +471 -0
- package/dist/cjs/management/__generated/managers/organizations-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/prompts-manager.d.ts +42 -0
- package/dist/cjs/management/__generated/managers/prompts-manager.js +101 -0
- package/dist/cjs/management/__generated/managers/prompts-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/resource-servers-manager.d.ts +48 -0
- package/dist/cjs/management/__generated/managers/resource-servers-manager.js +131 -0
- package/dist/cjs/management/__generated/managers/resource-servers-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/roles-manager.d.ts +110 -0
- package/dist/cjs/management/__generated/managers/roles-manager.js +238 -0
- package/dist/cjs/management/__generated/managers/roles-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/rules-configs-manager.d.ts +33 -0
- package/dist/cjs/management/__generated/managers/rules-configs-manager.js +82 -0
- package/dist/cjs/management/__generated/managers/rules-configs-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/rules-manager.d.ts +55 -0
- package/dist/cjs/management/__generated/managers/rules-manager.js +149 -0
- package/dist/cjs/management/__generated/managers/rules-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/stats-manager.d.ts +24 -0
- package/dist/cjs/management/__generated/managers/stats-manager.js +72 -0
- package/dist/cjs/management/__generated/managers/stats-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/tenants-manager.d.ts +24 -0
- package/dist/cjs/management/__generated/managers/tenants-manager.js +76 -0
- package/dist/cjs/management/__generated/managers/tenants-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/tickets-manager.d.ts +24 -0
- package/dist/cjs/management/__generated/managers/tickets-manager.js +69 -0
- package/dist/cjs/management/__generated/managers/tickets-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/user-blocks-manager.d.ts +45 -0
- package/dist/cjs/management/__generated/managers/user-blocks-manager.js +123 -0
- package/dist/cjs/management/__generated/managers/user-blocks-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/users-by-email-manager.d.ts +22 -0
- package/dist/cjs/management/__generated/managers/users-by-email-manager.js +69 -0
- package/dist/cjs/management/__generated/managers/users-by-email-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/users-manager.d.ts +329 -0
- package/dist/cjs/management/__generated/managers/users-manager.js +647 -0
- package/dist/cjs/management/__generated/managers/users-manager.js.map +1 -0
- package/dist/cjs/management/__generated/models/index.d.ts +14269 -0
- package/dist/cjs/management/__generated/models/index.js +1628 -0
- package/dist/cjs/management/__generated/models/index.js.map +1 -0
- package/dist/cjs/management/index.d.ts +3 -0
- package/dist/cjs/management/index.js +20 -0
- package/dist/cjs/management/index.js.map +1 -0
- package/dist/cjs/management/management-client-options.d.ts +17 -0
- package/dist/cjs/management/management-client-options.js +3 -0
- package/dist/cjs/management/management-client-options.js.map +1 -0
- package/dist/cjs/management/management-client.d.ts +16 -0
- package/dist/cjs/management/management-client.js +53 -0
- package/dist/cjs/management/management-client.js.map +1 -0
- package/dist/cjs/management/token-provider-middleware.d.ts +7 -0
- package/dist/cjs/management/token-provider-middleware.js +39 -0
- package/dist/cjs/management/token-provider-middleware.js.map +1 -0
- package/dist/cjs/management/token-provider.d.ts +21 -0
- package/dist/cjs/management/token-provider.js +36 -0
- package/dist/cjs/management/token-provider.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/userinfo/index.d.ts +55 -0
- package/dist/cjs/userinfo/index.js +69 -0
- package/dist/cjs/userinfo/index.js.map +1 -0
- package/dist/cjs/utils.d.ts +10 -0
- package/dist/cjs/utils.js +16 -0
- package/dist/cjs/utils.js.map +1 -0
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +5 -0
- package/dist/cjs/version.js.map +1 -0
- package/dist/esm/auth/base-auth-api.d.ts +39 -0
- package/dist/esm/auth/base-auth-api.js +97 -0
- package/dist/esm/auth/base-auth-api.js.map +1 -0
- package/dist/esm/auth/client-authentication.d.ts +26 -0
- package/dist/esm/auth/client-authentication.js +36 -0
- package/dist/esm/auth/client-authentication.js.map +1 -0
- package/dist/esm/auth/database.d.ts +157 -0
- package/dist/esm/auth/database.js +69 -0
- package/dist/esm/auth/database.js.map +1 -0
- package/dist/esm/auth/id-token-validator.d.ts +18 -0
- package/dist/esm/auth/id-token-validator.js +117 -0
- package/dist/esm/auth/id-token-validator.js.map +1 -0
- package/dist/esm/auth/index.d.ts +15 -0
- package/dist/esm/auth/index.js +16 -0
- package/dist/esm/auth/index.js.map +1 -0
- package/dist/esm/auth/oauth.d.ts +297 -0
- package/dist/esm/auth/oauth.js +168 -0
- package/dist/esm/auth/oauth.js.map +1 -0
- package/dist/esm/auth/passwordless.d.ts +165 -0
- package/dist/esm/auth/passwordless.js +158 -0
- package/dist/esm/auth/passwordless.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/lib/errors.d.ts +33 -0
- package/dist/esm/lib/errors.js +42 -0
- package/dist/esm/lib/errors.js.map +1 -0
- package/dist/esm/lib/index.d.ts +3 -0
- package/dist/esm/lib/index.js +3 -0
- package/dist/esm/lib/index.js.map +1 -0
- package/dist/esm/lib/middleware/telemetry-middleware.d.ts +12 -0
- package/dist/esm/lib/middleware/telemetry-middleware.js +23 -0
- package/dist/esm/lib/middleware/telemetry-middleware.js.map +1 -0
- package/dist/esm/lib/models.d.ts +123 -0
- package/dist/esm/lib/models.js +35 -0
- package/dist/esm/lib/models.js.map +1 -0
- package/dist/esm/lib/retry.d.ts +26 -0
- package/dist/esm/lib/retry.js +49 -0
- package/dist/esm/lib/retry.js.map +1 -0
- package/dist/esm/lib/runtime.d.ts +61 -0
- package/dist/esm/lib/runtime.js +207 -0
- package/dist/esm/lib/runtime.js.map +1 -0
- package/dist/esm/management/__generated/index.d.ts +39 -0
- package/dist/esm/management/__generated/index.js +40 -0
- package/dist/esm/management/__generated/index.js.map +1 -0
- package/dist/esm/management/__generated/managers/actions-manager.d.ts +136 -0
- package/dist/esm/management/__generated/managers/actions-manager.js +309 -0
- package/dist/esm/management/__generated/managers/actions-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/anomaly-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/anomaly-manager.js +36 -0
- package/dist/esm/management/__generated/managers/anomaly-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.d.ts +46 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.js +92 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/blacklists-manager.d.ts +28 -0
- package/dist/esm/management/__generated/managers/blacklists-manager.js +49 -0
- package/dist/esm/management/__generated/managers/blacklists-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/branding-manager.d.ts +103 -0
- package/dist/esm/management/__generated/managers/branding-manager.js +180 -0
- package/dist/esm/management/__generated/managers/branding-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/client-grants-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/client-grants-manager.js +87 -0
- package/dist/esm/management/__generated/managers/client-grants-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/clients-manager.d.ts +177 -0
- package/dist/esm/management/__generated/managers/clients-manager.js +278 -0
- package/dist/esm/management/__generated/managers/clients-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/connections-manager.d.ts +84 -0
- package/dist/esm/management/__generated/managers/connections-manager.js +171 -0
- package/dist/esm/management/__generated/managers/connections-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/custom-domains-manager.d.ts +106 -0
- package/dist/esm/management/__generated/managers/custom-domains-manager.js +152 -0
- package/dist/esm/management/__generated/managers/custom-domains-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/device-credentials-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/device-credentials-manager.js +85 -0
- package/dist/esm/management/__generated/managers/device-credentials-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/email-templates-manager.d.ts +38 -0
- package/dist/esm/management/__generated/managers/email-templates-manager.js +75 -0
- package/dist/esm/management/__generated/managers/email-templates-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/emails-manager.d.ts +40 -0
- package/dist/esm/management/__generated/managers/emails-manager.js +75 -0
- package/dist/esm/management/__generated/managers/emails-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/grants-manager.d.ts +34 -0
- package/dist/esm/management/__generated/managers/grants-manager.js +77 -0
- package/dist/esm/management/__generated/managers/grants-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/guardian-manager.d.ts +240 -0
- package/dist/esm/management/__generated/managers/guardian-manager.js +493 -0
- package/dist/esm/management/__generated/managers/guardian-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/hooks-manager.d.ts +90 -0
- package/dist/esm/management/__generated/managers/hooks-manager.js +187 -0
- package/dist/esm/management/__generated/managers/hooks-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/index.d.ts +31 -0
- package/dist/esm/management/__generated/managers/index.js +32 -0
- package/dist/esm/management/__generated/managers/index.js.map +1 -0
- package/dist/esm/management/__generated/managers/jobs-manager.d.ts +47 -0
- package/dist/esm/management/__generated/managers/jobs-manager.js +104 -0
- package/dist/esm/management/__generated/managers/jobs-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/keys-manager.d.ts +34 -0
- package/dist/esm/management/__generated/managers/keys-manager.js +58 -0
- package/dist/esm/management/__generated/managers/keys-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/log-streams-manager.d.ts +326 -0
- package/dist/esm/management/__generated/managers/log-streams-manager.js +365 -0
- package/dist/esm/management/__generated/managers/log-streams-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/logs-manager.d.ts +56 -0
- package/dist/esm/management/__generated/managers/logs-manager.js +68 -0
- package/dist/esm/management/__generated/managers/logs-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/organizations-manager.d.ts +191 -0
- package/dist/esm/management/__generated/managers/organizations-manager.js +444 -0
- package/dist/esm/management/__generated/managers/organizations-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/prompts-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/prompts-manager.js +74 -0
- package/dist/esm/management/__generated/managers/prompts-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/resource-servers-manager.d.ts +48 -0
- package/dist/esm/management/__generated/managers/resource-servers-manager.js +104 -0
- package/dist/esm/management/__generated/managers/resource-servers-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/roles-manager.d.ts +110 -0
- package/dist/esm/management/__generated/managers/roles-manager.js +211 -0
- package/dist/esm/management/__generated/managers/roles-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/rules-configs-manager.d.ts +33 -0
- package/dist/esm/management/__generated/managers/rules-configs-manager.js +55 -0
- package/dist/esm/management/__generated/managers/rules-configs-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/rules-manager.d.ts +55 -0
- package/dist/esm/management/__generated/managers/rules-manager.js +122 -0
- package/dist/esm/management/__generated/managers/rules-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/stats-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/stats-manager.js +45 -0
- package/dist/esm/management/__generated/managers/stats-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/tenants-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/tenants-manager.js +49 -0
- package/dist/esm/management/__generated/managers/tenants-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/tickets-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/tickets-manager.js +42 -0
- package/dist/esm/management/__generated/managers/tickets-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/user-blocks-manager.d.ts +45 -0
- package/dist/esm/management/__generated/managers/user-blocks-manager.js +96 -0
- package/dist/esm/management/__generated/managers/user-blocks-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/users-by-email-manager.d.ts +22 -0
- package/dist/esm/management/__generated/managers/users-by-email-manager.js +42 -0
- package/dist/esm/management/__generated/managers/users-by-email-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/users-manager.d.ts +329 -0
- package/dist/esm/management/__generated/managers/users-manager.js +620 -0
- package/dist/esm/management/__generated/managers/users-manager.js.map +1 -0
- package/dist/esm/management/__generated/models/index.d.ts +14269 -0
- package/dist/esm/management/__generated/models/index.js +1622 -0
- package/dist/esm/management/__generated/models/index.js.map +1 -0
- package/dist/esm/management/index.d.ts +3 -0
- package/dist/esm/management/index.js +4 -0
- package/dist/esm/management/index.js.map +1 -0
- package/dist/esm/management/management-client-options.d.ts +17 -0
- package/dist/esm/management/management-client-options.js +2 -0
- package/dist/esm/management/management-client-options.js.map +1 -0
- package/dist/esm/management/management-client.d.ts +16 -0
- package/dist/esm/management/management-client.js +48 -0
- package/dist/esm/management/management-client.js.map +1 -0
- package/dist/esm/management/token-provider-middleware.d.ts +7 -0
- package/dist/esm/management/token-provider-middleware.js +35 -0
- package/dist/esm/management/token-provider-middleware.js.map +1 -0
- package/dist/esm/management/token-provider.d.ts +21 -0
- package/dist/esm/management/token-provider.js +32 -0
- package/dist/esm/management/token-provider.js.map +1 -0
- package/dist/esm/userinfo/index.d.ts +55 -0
- package/dist/esm/userinfo/index.js +63 -0
- package/dist/esm/userinfo/index.js.map +1 -0
- package/dist/esm/utils.d.ts +10 -0
- package/dist/esm/utils.js +12 -0
- package/dist/esm/utils.js.map +1 -0
- package/dist/esm/version.d.ts +1 -0
- package/dist/esm/version.js +2 -0
- package/dist/esm/version.js.map +1 -0
- package/package.json +19 -21
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class ClientsManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Delete a client and related configuration (rules, connections, etc).
|
|
9
|
+
* Delete a client
|
|
10
|
+
*
|
|
11
|
+
* @throws {RequiredError}
|
|
12
|
+
*/
|
|
13
|
+
async delete(requestParameters, initOverrides) {
|
|
14
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
15
|
+
const response = await this.request({
|
|
16
|
+
path: `/clients/{client_id}`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
17
|
+
method: 'DELETE',
|
|
18
|
+
}, initOverrides);
|
|
19
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Delete a client credential
|
|
23
|
+
*
|
|
24
|
+
* @throws {RequiredError}
|
|
25
|
+
*/
|
|
26
|
+
async deleteCredential(requestParameters, initOverrides) {
|
|
27
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id', 'credential_id']);
|
|
28
|
+
const response = await this.request({
|
|
29
|
+
path: `/clients/{client_id}/credentials/{credential_id}`
|
|
30
|
+
.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id)))
|
|
31
|
+
.replace('{credential_id}', encodeURIComponent(String(requestParameters.credential_id))),
|
|
32
|
+
method: 'DELETE',
|
|
33
|
+
}, initOverrides);
|
|
34
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
35
|
+
}
|
|
36
|
+
async getAll(requestParameters = {}, initOverrides) {
|
|
37
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
38
|
+
{
|
|
39
|
+
key: 'fields',
|
|
40
|
+
config: {},
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
key: 'include_fields',
|
|
44
|
+
config: {},
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
key: 'page',
|
|
48
|
+
config: {},
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
key: 'per_page',
|
|
52
|
+
config: {},
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
key: 'include_totals',
|
|
56
|
+
config: {},
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
key: 'is_global',
|
|
60
|
+
config: {},
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
key: 'is_first_party',
|
|
64
|
+
config: {},
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
key: 'app_type',
|
|
68
|
+
config: {},
|
|
69
|
+
},
|
|
70
|
+
]);
|
|
71
|
+
const response = await this.request({
|
|
72
|
+
path: `/clients`,
|
|
73
|
+
method: 'GET',
|
|
74
|
+
query: queryParameters,
|
|
75
|
+
}, initOverrides);
|
|
76
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Retrieve client details. A list of fields to include or exclude may also be specified. Note:
|
|
80
|
+
* <ul>
|
|
81
|
+
* <li>
|
|
82
|
+
* <code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
83
|
+
* the any of the scopes.
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
87
|
+
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
88
|
+
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
89
|
+
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
90
|
+
* <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
|
|
91
|
+
* <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
|
|
92
|
+
* <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
|
|
93
|
+
* <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
|
|
94
|
+
* <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
|
|
95
|
+
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
96
|
+
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
97
|
+
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
98
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
99
|
+
* <code>organization_require_behavior</code>
|
|
100
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
101
|
+
* <code>read:client_keys</code> scope.
|
|
102
|
+
* </li>
|
|
103
|
+
* <li>
|
|
104
|
+
* <code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
105
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
106
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
107
|
+
* </li>
|
|
108
|
+
* </ul>
|
|
109
|
+
*
|
|
110
|
+
* Get a client
|
|
111
|
+
*
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
async get(requestParameters, initOverrides) {
|
|
115
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
116
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
117
|
+
{
|
|
118
|
+
key: 'fields',
|
|
119
|
+
config: {},
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
key: 'include_fields',
|
|
123
|
+
config: {},
|
|
124
|
+
},
|
|
125
|
+
]);
|
|
126
|
+
const response = await this.request({
|
|
127
|
+
path: `/clients/{client_id}`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
128
|
+
method: 'GET',
|
|
129
|
+
query: queryParameters,
|
|
130
|
+
}, initOverrides);
|
|
131
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Get the list of client credentials that are associated to the client.
|
|
135
|
+
*
|
|
136
|
+
* Important: To enable credentials to be used
|
|
137
|
+
* Get client credentials
|
|
138
|
+
*
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
async getCredentials(requestParameters, initOverrides) {
|
|
142
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
143
|
+
const response = await this.request({
|
|
144
|
+
path: `/clients/{client_id}/credentials`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
145
|
+
method: 'GET',
|
|
146
|
+
}, initOverrides);
|
|
147
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* Get the details of a client credential.
|
|
151
|
+
* Get client credential
|
|
152
|
+
*
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
*/
|
|
155
|
+
async getCredential(requestParameters, initOverrides) {
|
|
156
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id', 'credential_id']);
|
|
157
|
+
const response = await this.request({
|
|
158
|
+
path: `/clients/{client_id}/credentials/{credential_id}`
|
|
159
|
+
.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id)))
|
|
160
|
+
.replace('{credential_id}', encodeURIComponent(String(requestParameters.credential_id))),
|
|
161
|
+
method: 'GET',
|
|
162
|
+
}, initOverrides);
|
|
163
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Notes:
|
|
167
|
+
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
168
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
169
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
170
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
171
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, only specify the credential IDs
|
|
172
|
+
* that were generated when creating the credentials on the client.
|
|
173
|
+
* - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
|
|
174
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
175
|
+
* Update a client
|
|
176
|
+
*
|
|
177
|
+
* @throws {RequiredError}
|
|
178
|
+
*/
|
|
179
|
+
async update(requestParameters, bodyParameters, initOverrides) {
|
|
180
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
181
|
+
const headerParameters = {};
|
|
182
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
183
|
+
const response = await this.request({
|
|
184
|
+
path: `/clients/{client_id}`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
185
|
+
method: 'PATCH',
|
|
186
|
+
headers: headerParameters,
|
|
187
|
+
body: bodyParameters,
|
|
188
|
+
}, initOverrides);
|
|
189
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Update a client credential
|
|
193
|
+
*
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
async updateCredential(requestParameters, bodyParameters, initOverrides) {
|
|
197
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id', 'credential_id']);
|
|
198
|
+
const headerParameters = {};
|
|
199
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
200
|
+
const response = await this.request({
|
|
201
|
+
path: `/clients/{client_id}/credentials/{credential_id}`
|
|
202
|
+
.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id)))
|
|
203
|
+
.replace('{credential_id}', encodeURIComponent(String(requestParameters.credential_id))),
|
|
204
|
+
method: 'PATCH',
|
|
205
|
+
headers: headerParameters,
|
|
206
|
+
body: bodyParameters,
|
|
207
|
+
}, initOverrides);
|
|
208
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Create a new client (application or SSO integration).
|
|
212
|
+
*
|
|
213
|
+
* Notes:
|
|
214
|
+
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
215
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
216
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
217
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
218
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
219
|
+
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
220
|
+
* - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
|
|
221
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
222
|
+
*
|
|
223
|
+
* <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
|
|
224
|
+
*
|
|
225
|
+
* Create a client
|
|
226
|
+
*
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
async create(bodyParameters, initOverrides) {
|
|
230
|
+
const headerParameters = {};
|
|
231
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
232
|
+
const response = await this.request({
|
|
233
|
+
path: `/clients`,
|
|
234
|
+
method: 'POST',
|
|
235
|
+
headers: headerParameters,
|
|
236
|
+
body: bodyParameters,
|
|
237
|
+
}, initOverrides);
|
|
238
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Create a client credential associated to the client. The credential will be created but not yet enabled
|
|
242
|
+
* Create a client credential
|
|
243
|
+
*
|
|
244
|
+
* @throws {RequiredError}
|
|
245
|
+
*/
|
|
246
|
+
async createCredential(requestParameters, bodyParameters, initOverrides) {
|
|
247
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
248
|
+
const headerParameters = {};
|
|
249
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
250
|
+
const response = await this.request({
|
|
251
|
+
path: `/clients/{client_id}/credentials`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
252
|
+
method: 'POST',
|
|
253
|
+
headers: headerParameters,
|
|
254
|
+
body: bodyParameters,
|
|
255
|
+
}, initOverrides);
|
|
256
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Rotate a client secret.
|
|
260
|
+
*
|
|
261
|
+
* This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt).
|
|
262
|
+
*
|
|
263
|
+
* Note: The generated secret is NOT base64 encoded.
|
|
264
|
+
*
|
|
265
|
+
* Rotate a client secret
|
|
266
|
+
*
|
|
267
|
+
* @throws {RequiredError}
|
|
268
|
+
*/
|
|
269
|
+
async rotateClientSecret(requestParameters, initOverrides) {
|
|
270
|
+
runtime.validateRequiredRequestParams(requestParameters, ['client_id']);
|
|
271
|
+
const response = await this.request({
|
|
272
|
+
path: `/clients/{client_id}/rotate-secret`.replace('{client_id}', encodeURIComponent(String(requestParameters.client_id))),
|
|
273
|
+
method: 'POST',
|
|
274
|
+
}, initOverrides);
|
|
275
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
//# sourceMappingURL=clients-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"clients-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/clients-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAuBnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,OAAO;IACzC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,iBAA2C,EAC3C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,sBAAsB,CAAC,OAAO,CAClC,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAyD,EACzD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kDAAkD;iBACrD,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC/E,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IA+CD,KAAK,CAAC,MAAM,CACV,oBAAuC,EAAE,EACzC,aAA4B;QAE5B,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,GAAG,CACP,iBAAwC,EACxC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,sBAAsB,CAAC,OAAO,CAClC,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAClB,iBAAwC,EACxC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kCAAkC,CAAC,OAAO,CAC9C,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,iBAAsD,EACtD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kDAAkD;iBACrD,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC/E,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACV,iBAA0C,EAC1C,cAA4B,EAC5B,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,sBAAsB,CAAC,OAAO,CAClC,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAiE,EACjE,cAAqD,EACrD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAEzF,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kDAAkD;iBACrD,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC/E,OAAO,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1F,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,cAA4B,EAC5B,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,iBAAkD,EAClD,cAAsC,EACtC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kCAAkC,CAAC,OAAO,CAC9C,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,kBAAkB,CACtB,iBAA0C,EAC1C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,oCAAoC,CAAC,OAAO,CAChD,aAAa,EACb,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CACxD;YACD,MAAM,EAAE,MAAM;SACf,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Connection, ConnectionCreate, ConnectionUpdate, GetConnections200ResponseOneOf, DeleteConnectionsByIdRequest, DeleteUsersByEmailRequest, GetConnectionsRequest, GetConnectionsByIdRequest, GetStatusRequest, PatchConnectionsByIdRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ConnectionsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Deletes a connection and all its users.
|
|
11
|
+
*
|
|
12
|
+
* Delete a connection
|
|
13
|
+
*
|
|
14
|
+
* @throws {RequiredError}
|
|
15
|
+
*/
|
|
16
|
+
delete(requestParameters: DeleteConnectionsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
17
|
+
/**
|
|
18
|
+
* Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
|
|
19
|
+
*
|
|
20
|
+
* Delete a connection user
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
*/
|
|
24
|
+
deleteUserByEmail(requestParameters: DeleteUsersByEmailRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
25
|
+
/**
|
|
26
|
+
* Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
|
|
27
|
+
* This endpoint supports two types of pagination:
|
|
28
|
+
* - Offset pagination
|
|
29
|
+
* - Checkpoint pagination
|
|
30
|
+
*
|
|
31
|
+
* Checkpoint pagination should be used if you need to retrieve more than 1000 connections.
|
|
32
|
+
*
|
|
33
|
+
* <h2>Checkpoint Pagination</h2>
|
|
34
|
+
*
|
|
35
|
+
* To search by checkpoint, use the following parameters:
|
|
36
|
+
* - from: Optional id from which to start selection.
|
|
37
|
+
* - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
|
|
38
|
+
*
|
|
39
|
+
* The first time you call this endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter.
|
|
40
|
+
* If there are more results, a <code>next</code> value will be included in the response. You can use this for subsequent API calls.
|
|
41
|
+
* When <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
|
|
42
|
+
*
|
|
43
|
+
* Note: The <code>include_totals</code> parameter is not supported when using checkpoint pagination.
|
|
44
|
+
* Get all connections
|
|
45
|
+
*
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getAll(requestParameters: GetConnectionsRequest & {
|
|
49
|
+
include_totals: true;
|
|
50
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetConnections200ResponseOneOf>>;
|
|
51
|
+
getAll(requestParameters?: GetConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Connection>>>;
|
|
52
|
+
/**
|
|
53
|
+
* Retrieves a connection by its <code>ID</code>.
|
|
54
|
+
*
|
|
55
|
+
* Get a connection
|
|
56
|
+
*
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
get(requestParameters: GetConnectionsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieves the status of an ad/ldap connection referenced by its <code>ID</code>. <code>200 OK</code> http status code response is returned when the connection is online, otherwise a <code>404</code> status code is returned along with an error message
|
|
62
|
+
* Check connection status
|
|
63
|
+
*
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
checkStatus(requestParameters: GetStatusRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
67
|
+
/**
|
|
68
|
+
* <b>Note:</b> if you use the options parameter, the whole options object will be overridden, so ensure that all parameters are present
|
|
69
|
+
*
|
|
70
|
+
* Update a connection
|
|
71
|
+
*
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
update(requestParameters: PatchConnectionsByIdRequest, bodyParameters: ConnectionUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
75
|
+
/**
|
|
76
|
+
* Creates a new connection according to the JSON object received in <code>body</code>.
|
|
77
|
+
*
|
|
78
|
+
* Create a connection
|
|
79
|
+
*
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
create(bodyParameters: ConnectionCreate, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
83
|
+
}
|
|
84
|
+
export {};
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class ConnectionsManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Deletes a connection and all its users.
|
|
9
|
+
*
|
|
10
|
+
* Delete a connection
|
|
11
|
+
*
|
|
12
|
+
* @throws {RequiredError}
|
|
13
|
+
*/
|
|
14
|
+
async delete(requestParameters, initOverrides) {
|
|
15
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
16
|
+
const response = await this.request({
|
|
17
|
+
path: `/connections/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
18
|
+
method: 'DELETE',
|
|
19
|
+
}, initOverrides);
|
|
20
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
|
|
24
|
+
*
|
|
25
|
+
* Delete a connection user
|
|
26
|
+
*
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
async deleteUserByEmail(requestParameters, initOverrides) {
|
|
30
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id', 'email']);
|
|
31
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
32
|
+
{
|
|
33
|
+
key: 'email',
|
|
34
|
+
config: {},
|
|
35
|
+
},
|
|
36
|
+
]);
|
|
37
|
+
const response = await this.request({
|
|
38
|
+
path: `/connections/{id}/users`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
39
|
+
method: 'DELETE',
|
|
40
|
+
query: queryParameters,
|
|
41
|
+
}, initOverrides);
|
|
42
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
43
|
+
}
|
|
44
|
+
async getAll(requestParameters = {}, initOverrides) {
|
|
45
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
46
|
+
{
|
|
47
|
+
key: 'per_page',
|
|
48
|
+
config: {},
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
key: 'page',
|
|
52
|
+
config: {},
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
key: 'include_totals',
|
|
56
|
+
config: {},
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
key: 'from',
|
|
60
|
+
config: {},
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
key: 'take',
|
|
64
|
+
config: {},
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
key: 'strategy',
|
|
68
|
+
config: {
|
|
69
|
+
isArray: true,
|
|
70
|
+
isCollectionFormatMulti: true,
|
|
71
|
+
},
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
key: 'name',
|
|
75
|
+
config: {},
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
key: 'fields',
|
|
79
|
+
config: {},
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
key: 'include_fields',
|
|
83
|
+
config: {},
|
|
84
|
+
},
|
|
85
|
+
]);
|
|
86
|
+
const response = await this.request({
|
|
87
|
+
path: `/connections`,
|
|
88
|
+
method: 'GET',
|
|
89
|
+
query: queryParameters,
|
|
90
|
+
}, initOverrides);
|
|
91
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Retrieves a connection by its <code>ID</code>.
|
|
95
|
+
*
|
|
96
|
+
* Get a connection
|
|
97
|
+
*
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
async get(requestParameters, initOverrides) {
|
|
101
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
102
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
103
|
+
{
|
|
104
|
+
key: 'fields',
|
|
105
|
+
config: {},
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
key: 'include_fields',
|
|
109
|
+
config: {},
|
|
110
|
+
},
|
|
111
|
+
]);
|
|
112
|
+
const response = await this.request({
|
|
113
|
+
path: `/connections/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
114
|
+
method: 'GET',
|
|
115
|
+
query: queryParameters,
|
|
116
|
+
}, initOverrides);
|
|
117
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Retrieves the status of an ad/ldap connection referenced by its <code>ID</code>. <code>200 OK</code> http status code response is returned when the connection is online, otherwise a <code>404</code> status code is returned along with an error message
|
|
121
|
+
* Check connection status
|
|
122
|
+
*
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
async checkStatus(requestParameters, initOverrides) {
|
|
126
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
127
|
+
const response = await this.request({
|
|
128
|
+
path: `/connections/{id}/status`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
129
|
+
method: 'GET',
|
|
130
|
+
}, initOverrides);
|
|
131
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* <b>Note:</b> if you use the options parameter, the whole options object will be overridden, so ensure that all parameters are present
|
|
135
|
+
*
|
|
136
|
+
* Update a connection
|
|
137
|
+
*
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
async update(requestParameters, bodyParameters, initOverrides) {
|
|
141
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
142
|
+
const headerParameters = {};
|
|
143
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
144
|
+
const response = await this.request({
|
|
145
|
+
path: `/connections/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
146
|
+
method: 'PATCH',
|
|
147
|
+
headers: headerParameters,
|
|
148
|
+
body: bodyParameters,
|
|
149
|
+
}, initOverrides);
|
|
150
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Creates a new connection according to the JSON object received in <code>body</code>.
|
|
154
|
+
*
|
|
155
|
+
* Create a connection
|
|
156
|
+
*
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
async create(bodyParameters, initOverrides) {
|
|
160
|
+
const headerParameters = {};
|
|
161
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
162
|
+
const response = await this.request({
|
|
163
|
+
path: `/connections`,
|
|
164
|
+
method: 'POST',
|
|
165
|
+
headers: headerParameters,
|
|
166
|
+
body: bodyParameters,
|
|
167
|
+
}, initOverrides);
|
|
168
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
//# sourceMappingURL=connections-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connections-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/connections-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAgBnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,OAAO;IAC7C;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,iBAA+C,EAC/C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,iBAA4C,EAC5C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAE1E,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,OAAO;gBACZ,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,yBAAyB,CAAC,OAAO,CACrC,MAAM,EACN,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CACjD;YACD,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAiCD,KAAK,CAAC,MAAM,CACV,oBAA2C,EAAE,EAC7C,aAA4B;QAE5B,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,UAAU;gBACf,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI;oBACb,uBAAuB,EAAE,IAAI;iBAC9B;aACF;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CACP,iBAA4C,EAC5C,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;gBACE,GAAG,EAAE,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,eAAe;SACvB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,iBAAmC,EACnC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,0BAA0B,CAAC,OAAO,CACtC,MAAM,EACN,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CACjD;YACD,MAAM,EAAE,KAAK;SACd,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,iBAA8C,EAC9C,cAAgC,EAChC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjE,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3F,MAAM,EAAE,OAAO;YACf,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,cAAgC,EAChC,aAA4B;QAE5B,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,IAAI,EAAE,cAAc;SACrB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;CACF"}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { CustomDomain, PatchCustomDomainsByIdRequest, PostCustomDomains201Response, PostCustomDomainsRequest, PostVerify200Response, DeleteCustomDomainsByIdRequest, GetCustomDomainsByIdRequest, PatchCustomDomainsByIdOperationRequest, PostVerifyRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class CustomDomainsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a custom domain and stop serving requests for it.
|
|
11
|
+
* Delete custom domain configuration
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteCustomDomainsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve details on <a href="https://auth0.com/docs/custom-domains">custom domains</a>.
|
|
18
|
+
* Get custom domains configurations
|
|
19
|
+
*
|
|
20
|
+
* @throws {RequiredError}
|
|
21
|
+
*/
|
|
22
|
+
getAll(initOverrides?: InitOverride): Promise<ApiResponse<Array<CustomDomain>>>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieve a custom domain configuration and status.
|
|
25
|
+
* Get custom domain configuration
|
|
26
|
+
*
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
get(requestParameters: GetCustomDomainsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<CustomDomain>>;
|
|
30
|
+
/**
|
|
31
|
+
* Update a custom domain.
|
|
32
|
+
*
|
|
33
|
+
* These are the attributes that can be updated:
|
|
34
|
+
*
|
|
35
|
+
* - custom_client_ip_header
|
|
36
|
+
* - tls_policy
|
|
37
|
+
*
|
|
38
|
+
* <h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to
|
|
39
|
+
* send should be:
|
|
40
|
+
* <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
|
|
41
|
+
*
|
|
42
|
+
* <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be:
|
|
43
|
+
* <pre><code>{ "tls_policy": "compatible" }</code></pre>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* TLS Policies:
|
|
47
|
+
*
|
|
48
|
+
* - recommended - for modern usage this includes TLS 1.2 only
|
|
49
|
+
* - compatible - compatible with older browsers this policy includes TLS 1.0, 1.1, 1.2
|
|
50
|
+
*
|
|
51
|
+
*
|
|
52
|
+
* Some considerations:
|
|
53
|
+
*
|
|
54
|
+
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
55
|
+
* - Do not use the <code>compatible</code> TLS policy unless you have clients that require TLS 1.0.
|
|
56
|
+
*
|
|
57
|
+
* Update custom domain configuration
|
|
58
|
+
*
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
*/
|
|
61
|
+
update(requestParameters: PatchCustomDomainsByIdOperationRequest, bodyParameters: PatchCustomDomainsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostCustomDomains201Response>>;
|
|
62
|
+
/**
|
|
63
|
+
* Create a new custom domain.
|
|
64
|
+
*
|
|
65
|
+
* Note: The custom domain will need to be verified before it will accept
|
|
66
|
+
* requests.
|
|
67
|
+
*
|
|
68
|
+
* Optional attributes that can be updated:
|
|
69
|
+
*
|
|
70
|
+
* - custom_client_ip_header
|
|
71
|
+
* - tls_policy
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* TLS Policies:
|
|
75
|
+
*
|
|
76
|
+
* - recommended - for modern usage this includes TLS 1.2 only
|
|
77
|
+
* - compatible - compatible with older browsers this policy includes TLS 1.0, 1.1, 1.2
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* Some considerations:
|
|
81
|
+
*
|
|
82
|
+
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
83
|
+
* - Do not use the <code>compatible</code> TLS policy unless you have clients that require TLS 1.0.
|
|
84
|
+
*
|
|
85
|
+
* Configure a new custom domain
|
|
86
|
+
*
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
create(bodyParameters: PostCustomDomainsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostCustomDomains201Response>>;
|
|
90
|
+
/**
|
|
91
|
+
* Run the verification process on a custom domain.
|
|
92
|
+
*
|
|
93
|
+
* Note: Check the <code>status</code> field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
|
|
94
|
+
*
|
|
95
|
+
* For <code>self_managed_certs</code>, when the custom domain is verified for the first time, the response will also include the <code>cname_api_key</code> which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
|
|
96
|
+
*
|
|
97
|
+
* <a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates.
|
|
98
|
+
* <a href="https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Self Managed certificates.
|
|
99
|
+
*
|
|
100
|
+
* Verify a custom domain
|
|
101
|
+
*
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
verify(requestParameters: PostVerifyRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostVerify200Response>>;
|
|
105
|
+
}
|
|
106
|
+
export {};
|