auth0 3.4.0 → 4.0.0-beta.1
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 +19 -15
- package/dist/cjs/auth/base-auth-api.js +60 -0
- package/dist/cjs/auth/base-auth-api.js.map +1 -0
- package/dist/cjs/auth/client-authentication.js +64 -0
- package/dist/cjs/auth/client-authentication.js.map +1 -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.js +135 -0
- package/dist/cjs/auth/id-token-validator.js.map +1 -0
- package/dist/cjs/auth/index.js +40 -0
- package/dist/cjs/auth/index.js.map +1 -0
- package/dist/cjs/auth/oauth.js +199 -0
- package/dist/cjs/auth/oauth.js.map +1 -0
- package/dist/cjs/auth/passwordless.js +154 -0
- package/dist/cjs/auth/passwordless.js.map +1 -0
- package/dist/cjs/index.js +19 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/lib/errors.js +49 -0
- package/dist/cjs/lib/errors.js.map +1 -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.js +27 -0
- package/dist/cjs/lib/middleware/telemetry-middleware.js.map +1 -0
- package/dist/cjs/lib/models.js +41 -0
- package/dist/cjs/lib/models.js.map +1 -0
- package/dist/cjs/lib/retry.js +55 -0
- package/dist/cjs/lib/retry.js.map +1 -0
- package/dist/cjs/lib/runtime.js +250 -0
- package/dist/cjs/lib/runtime.js.map +1 -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.js +336 -0
- package/dist/cjs/management/__generated/managers/actions-manager.js.map +1 -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.js +131 -0
- package/dist/cjs/management/__generated/managers/attack-protection-manager.js.map +1 -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.js +207 -0
- package/dist/cjs/management/__generated/managers/branding-manager.js.map +1 -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.js +238 -0
- package/dist/cjs/management/__generated/managers/clients-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/connections-manager.js +193 -0
- package/dist/cjs/management/__generated/managers/connections-manager.js.map +1 -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.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.js +102 -0
- package/dist/cjs/management/__generated/managers/email-templates-manager.js.map +1 -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.js +103 -0
- package/dist/cjs/management/__generated/managers/grants-manager.js.map +1 -0
- package/dist/cjs/management/__generated/managers/guardian-manager.js +518 -0
- package/dist/cjs/management/__generated/managers/guardian-manager.js.map +1 -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.js +48 -0
- package/dist/cjs/management/__generated/managers/index.js.map +1 -0
- package/dist/cjs/management/__generated/managers/jobs-manager.js +139 -0
- package/dist/cjs/management/__generated/managers/jobs-manager.js.map +1 -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.js +392 -0
- package/dist/cjs/management/__generated/managers/log-streams-manager.js.map +1 -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.js +463 -0
- package/dist/cjs/management/__generated/managers/organizations-manager.js.map +1 -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.js +131 -0
- package/dist/cjs/management/__generated/managers/resource-servers-manager.js.map +1 -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.js +82 -0
- package/dist/cjs/management/__generated/managers/rules-configs-manager.js.map +1 -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.js +72 -0
- package/dist/cjs/management/__generated/managers/stats-manager.js.map +1 -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.js +69 -0
- package/dist/cjs/management/__generated/managers/tickets-manager.js.map +1 -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.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.js +634 -0
- package/dist/cjs/management/__generated/managers/users-manager.js.map +1 -0
- package/dist/cjs/management/__generated/models/index.js +1581 -0
- package/dist/cjs/management/__generated/models/index.js.map +1 -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.js +3 -0
- package/dist/cjs/management/management-client-options.js.map +1 -0
- package/dist/cjs/management/management-client.js +54 -0
- package/dist/cjs/management/management-client.js.map +1 -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.js +36 -0
- package/dist/cjs/management/token-provider.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/utils.js +16 -0
- package/dist/cjs/utils.js.map +1 -0
- package/dist/cjs/version.js +5 -0
- package/dist/cjs/version.js.map +1 -0
- package/dist/esm/auth/base-auth-api.js +55 -0
- package/dist/esm/auth/base-auth-api.js.map +1 -0
- package/dist/esm/auth/client-authentication.js +37 -0
- package/dist/esm/auth/client-authentication.js.map +1 -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.js +107 -0
- package/dist/esm/auth/id-token-validator.js.map +1 -0
- package/dist/esm/auth/index.js +20 -0
- package/dist/esm/auth/index.js.map +1 -0
- package/dist/esm/auth/oauth.js +195 -0
- package/dist/esm/auth/oauth.js.map +1 -0
- package/dist/esm/auth/passwordless.js +150 -0
- package/dist/esm/auth/passwordless.js.map +1 -0
- package/dist/esm/index.js +3 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/lib/errors.js +42 -0
- package/dist/esm/lib/errors.js.map +1 -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.js +23 -0
- package/dist/esm/lib/middleware/telemetry-middleware.js.map +1 -0
- package/dist/esm/lib/models.js +35 -0
- package/dist/esm/lib/models.js.map +1 -0
- package/dist/esm/lib/retry.js +51 -0
- package/dist/esm/lib/retry.js.map +1 -0
- package/dist/esm/lib/runtime.js +225 -0
- package/dist/esm/lib/runtime.js.map +1 -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.js +309 -0
- package/dist/esm/management/__generated/managers/actions-manager.js.map +1 -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.js +104 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.js.map +1 -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.js +180 -0
- package/dist/esm/management/__generated/managers/branding-manager.js.map +1 -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.js +211 -0
- package/dist/esm/management/__generated/managers/clients-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/connections-manager.js +166 -0
- package/dist/esm/management/__generated/managers/connections-manager.js.map +1 -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.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.js +75 -0
- package/dist/esm/management/__generated/managers/email-templates-manager.js.map +1 -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.js +76 -0
- package/dist/esm/management/__generated/managers/grants-manager.js.map +1 -0
- package/dist/esm/management/__generated/managers/guardian-manager.js +491 -0
- package/dist/esm/management/__generated/managers/guardian-manager.js.map +1 -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.js +32 -0
- package/dist/esm/management/__generated/managers/index.js.map +1 -0
- package/dist/esm/management/__generated/managers/jobs-manager.js +112 -0
- package/dist/esm/management/__generated/managers/jobs-manager.js.map +1 -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.js +365 -0
- package/dist/esm/management/__generated/managers/log-streams-manager.js.map +1 -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.js +436 -0
- package/dist/esm/management/__generated/managers/organizations-manager.js.map +1 -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.js +104 -0
- package/dist/esm/management/__generated/managers/resource-servers-manager.js.map +1 -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.js +55 -0
- package/dist/esm/management/__generated/managers/rules-configs-manager.js.map +1 -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.js +45 -0
- package/dist/esm/management/__generated/managers/stats-manager.js.map +1 -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.js +42 -0
- package/dist/esm/management/__generated/managers/tickets-manager.js.map +1 -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.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.js +607 -0
- package/dist/esm/management/__generated/managers/users-manager.js.map +1 -0
- package/dist/esm/management/__generated/models/index.js +1575 -0
- package/dist/esm/management/__generated/models/index.js.map +1 -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.js +2 -0
- package/dist/esm/management/management-client-options.js.map +1 -0
- package/dist/esm/management/management-client.js +49 -0
- package/dist/esm/management/management-client.js.map +1 -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.js +32 -0
- package/dist/esm/management/token-provider.js.map +1 -0
- package/dist/esm/utils.js +12 -0
- package/dist/esm/utils.js.map +1 -0
- package/dist/esm/version.js +2 -0
- package/dist/esm/version.js.map +1 -0
- package/dist/typings/auth/base-auth-api.d.ts +33 -0
- package/dist/typings/auth/client-authentication.d.ts +26 -0
- package/dist/typings/auth/database.d.ts +153 -0
- package/dist/typings/auth/id-token-validator.d.ts +18 -0
- package/dist/typings/auth/index.d.ts +15 -0
- package/dist/typings/auth/oauth.d.ts +295 -0
- package/dist/typings/auth/passwordless.d.ts +165 -0
- package/dist/typings/index.d.ts +2 -0
- package/dist/typings/lib/errors.d.ts +34 -0
- package/dist/typings/lib/index.d.ts +3 -0
- package/dist/typings/lib/middleware/telemetry-middleware.d.ts +12 -0
- package/dist/typings/lib/models.d.ts +124 -0
- package/dist/typings/lib/retry.d.ts +27 -0
- package/dist/typings/lib/runtime.d.ts +69 -0
- package/dist/typings/management/__generated/index.d.ts +39 -0
- package/dist/typings/management/__generated/managers/actions-manager.d.ts +136 -0
- package/dist/typings/management/__generated/managers/anomaly-manager.d.ts +24 -0
- package/dist/typings/management/__generated/managers/attack-protection-manager.d.ts +52 -0
- package/dist/typings/management/__generated/managers/blacklists-manager.d.ts +28 -0
- package/dist/typings/management/__generated/managers/branding-manager.d.ts +103 -0
- package/dist/typings/management/__generated/managers/client-grants-manager.d.ts +42 -0
- package/dist/typings/management/__generated/managers/clients-manager.d.ts +119 -0
- package/dist/typings/management/__generated/managers/connections-manager.d.ts +71 -0
- package/dist/typings/management/__generated/managers/custom-domains-manager.d.ts +106 -0
- package/dist/typings/management/__generated/managers/device-credentials-manager.d.ts +42 -0
- package/dist/typings/management/__generated/managers/email-templates-manager.d.ts +38 -0
- package/dist/typings/management/__generated/managers/emails-manager.d.ts +40 -0
- package/dist/typings/management/__generated/managers/grants-manager.d.ts +34 -0
- package/dist/typings/management/__generated/managers/guardian-manager.d.ts +240 -0
- package/dist/typings/management/__generated/managers/hooks-manager.d.ts +94 -0
- package/dist/typings/management/__generated/managers/index.d.ts +31 -0
- package/dist/typings/management/__generated/managers/jobs-manager.d.ts +47 -0
- package/dist/typings/management/__generated/managers/keys-manager.d.ts +34 -0
- package/dist/typings/management/__generated/managers/log-streams-manager.d.ts +326 -0
- package/dist/typings/management/__generated/managers/logs-manager.d.ts +56 -0
- package/dist/typings/management/__generated/managers/organizations-manager.d.ts +191 -0
- package/dist/typings/management/__generated/managers/prompts-manager.d.ts +42 -0
- package/dist/typings/management/__generated/managers/resource-servers-manager.d.ts +48 -0
- package/dist/typings/management/__generated/managers/roles-manager.d.ts +110 -0
- package/dist/typings/management/__generated/managers/rules-configs-manager.d.ts +33 -0
- package/dist/typings/management/__generated/managers/rules-manager.d.ts +55 -0
- package/dist/typings/management/__generated/managers/stats-manager.d.ts +24 -0
- package/dist/typings/management/__generated/managers/tenants-manager.d.ts +24 -0
- package/dist/typings/management/__generated/managers/tickets-manager.d.ts +24 -0
- package/dist/typings/management/__generated/managers/user-blocks-manager.d.ts +45 -0
- package/dist/typings/management/__generated/managers/users-by-email-manager.d.ts +22 -0
- package/dist/typings/management/__generated/managers/users-manager.d.ts +323 -0
- package/dist/typings/management/__generated/models/index.d.ts +12704 -0
- package/dist/typings/management/index.d.ts +3 -0
- package/dist/typings/management/management-client-options.d.ts +17 -0
- package/dist/typings/management/management-client.d.ts +17 -0
- package/dist/typings/management/token-provider-middleware.d.ts +7 -0
- package/dist/typings/management/token-provider.d.ts +21 -0
- package/dist/typings/utils.d.ts +10 -0
- package/dist/typings/version.d.ts +1 -0
- package/package.json +47 -33
- package/CHANGELOG.md +0 -685
- package/src/Auth0RestClient.js +0 -123
- package/src/RetryRestClient.js +0 -105
- package/src/auth/DatabaseAuthenticator.js +0 -282
- package/src/auth/OAUthWithIDTokenValidation.js +0 -124
- package/src/auth/OAuthAuthenticator.js +0 -405
- package/src/auth/PasswordlessAuthenticator.js +0 -303
- package/src/auth/TokensManager.js +0 -254
- package/src/auth/UsersManager.js +0 -161
- package/src/auth/clientAuthentication.js +0 -86
- package/src/auth/idToken.js +0 -167
- package/src/auth/index.js +0 -573
- package/src/errors.js +0 -60
- package/src/index.js +0 -11
- package/src/index.mjs +0 -4
- package/src/management/ActionsManager.js +0 -526
- package/src/management/AttackProtectionManager.js +0 -158
- package/src/management/BaseManager.js +0 -41
- package/src/management/BlacklistedTokensManager.js +0 -67
- package/src/management/BrandingManager.js +0 -250
- package/src/management/ClientCredentialsManager.js +0 -112
- package/src/management/ClientGrantsManager.js +0 -124
- package/src/management/ClientsManager.js +0 -184
- package/src/management/ConnectionsManager.js +0 -213
- package/src/management/CustomDomainsManager.js +0 -141
- package/src/management/DeviceCredentialsManager.js +0 -91
- package/src/management/EmailProviderManager.js +0 -101
- package/src/management/EmailTemplatesManager.js +0 -90
- package/src/management/GrantsManager.js +0 -84
- package/src/management/GuardianManager.js +0 -361
- package/src/management/HooksManager.js +0 -295
- package/src/management/JobsManager.js +0 -324
- package/src/management/LogStreamsManager.js +0 -136
- package/src/management/LogsManager.js +0 -82
- package/src/management/ManagementTokenProvider.js +0 -144
- package/src/management/MigrationsManager.js +0 -76
- package/src/management/OrganizationsManager.js +0 -721
- package/src/management/PromptsManager.js +0 -162
- package/src/management/ResourceServersManager.js +0 -143
- package/src/management/RolesManager.js +0 -329
- package/src/management/RulesConfigsManager.js +0 -86
- package/src/management/RulesManager.js +0 -148
- package/src/management/StatsManager.js +0 -84
- package/src/management/TenantManager.js +0 -76
- package/src/management/TicketsManager.js +0 -104
- package/src/management/UserBlocksManager.js +0 -121
- package/src/management/UsersManager.js +0 -882
- package/src/management/index.js +0 -3409
- package/src/utils.js +0 -60
|
@@ -0,0 +1,166 @@
|
|
|
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: 'strategy',
|
|
60
|
+
config: {
|
|
61
|
+
isArray: true,
|
|
62
|
+
isCollectionFormatMulti: true,
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
key: 'name',
|
|
67
|
+
config: {},
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
key: 'fields',
|
|
71
|
+
config: {},
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
key: 'include_fields',
|
|
75
|
+
config: {},
|
|
76
|
+
},
|
|
77
|
+
]);
|
|
78
|
+
const response = await this.request({
|
|
79
|
+
path: `/connections`,
|
|
80
|
+
method: 'GET',
|
|
81
|
+
query: queryParameters,
|
|
82
|
+
}, initOverrides);
|
|
83
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Retrieves a connection by its <code>ID</code>.
|
|
87
|
+
*
|
|
88
|
+
* Get a connection
|
|
89
|
+
*
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
async get(requestParameters, initOverrides) {
|
|
93
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
94
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
95
|
+
{
|
|
96
|
+
key: 'fields',
|
|
97
|
+
config: {},
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
key: 'include_fields',
|
|
101
|
+
config: {},
|
|
102
|
+
},
|
|
103
|
+
]);
|
|
104
|
+
const response = await this.request({
|
|
105
|
+
path: `/connections/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
106
|
+
method: 'GET',
|
|
107
|
+
query: queryParameters,
|
|
108
|
+
}, initOverrides);
|
|
109
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* 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
|
|
113
|
+
* Check connection status
|
|
114
|
+
*
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
async checkStatus(requestParameters, initOverrides) {
|
|
118
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
119
|
+
const response = await this.request({
|
|
120
|
+
path: `/connections/{id}/status`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
121
|
+
method: 'GET',
|
|
122
|
+
}, initOverrides);
|
|
123
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* <b>Note:</b> if you use the options parameter, the whole options object will be overridden, so ensure that all parameters are present
|
|
127
|
+
*
|
|
128
|
+
* Update a connection
|
|
129
|
+
*
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
async update(requestParameters, bodyParameters, initOverrides) {
|
|
133
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
134
|
+
const headerParameters = {};
|
|
135
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
136
|
+
const response = await this.request({
|
|
137
|
+
path: `/connections/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
138
|
+
method: 'PATCH',
|
|
139
|
+
headers: headerParameters,
|
|
140
|
+
body: bodyParameters,
|
|
141
|
+
}, initOverrides);
|
|
142
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Creates a new connection according to the JSON object received in <code>body</code>.
|
|
146
|
+
* The samples on the right show all available attributes. Mandatory attributes are <code>name</code> and <code>strategy</code>.
|
|
147
|
+
* Valid Strategy names are: <code>ad</code>, <code>adfs</code>, <code>amazon</code>, <code>apple</code>, <code>dropbox</code>, <code>bitbucket</code>, <code>aol</code>, <code>auth0-oidc</code>, <code>auth0</code>, <code>baidu</code>, <code>bitly</code>, <code>box</code>, <code>custom</code>, <code>daccount</code>, <code>dwolla</code>, <code>email</code>, <code>evernote-sandbox</code>, <code>evernote</code>, <code>exact</code>, <code>facebook</code>, <code>fitbit</code>, <code>flickr</code>, <code>github</code>, <code>google-apps</code>, <code>google-oauth2</code>, <code>instagram</code>, <code>ip</code>, <code>line</code>, <code>linkedin</code>, <code>miicard</code>, <code>oauth1</code>, <code>oauth2</code>, <code>office365</code>, <code>oidc</code>, <code>okta</code>, <code>paypal</code>, <code>paypal-sandbox</code>, <code>pingfederate</code>, <code>planningcenter</code>, <code>renren</code>, <code>salesforce-community</code>, <code>salesforce-sandbox</code>, <code>salesforce</code>, <code>samlp</code>, <code>sharepoint</code>, <code>shopify</code>, <code>sms</code>, <code>soundcloud</code>, <code>thecity-sandbox</code>, <code>thecity</code>, <code>thirtysevensignals</code>, <code>twitter</code>, <code>untappd</code>, <code>vkontakte</code>, <code>waad</code>, <code>weibo</code>, <code>windowslive</code>, <code>wordpress</code>, <code>yahoo</code>, <code>yammer</code>, <code>yandex</code>
|
|
148
|
+
*
|
|
149
|
+
* <div class="alert alert-warning">Connections created via this endpoint may redirect users to log in, receive and store user identities, and update user root profiles</div>
|
|
150
|
+
* Create a connection
|
|
151
|
+
*
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
*/
|
|
154
|
+
async create(bodyParameters, initOverrides) {
|
|
155
|
+
const headerParameters = {};
|
|
156
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
157
|
+
const response = await this.request({
|
|
158
|
+
path: `/connections`,
|
|
159
|
+
method: 'POST',
|
|
160
|
+
headers: headerParameters,
|
|
161
|
+
body: bodyParameters,
|
|
162
|
+
}, initOverrides);
|
|
163
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
//# 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;IAiBD,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,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;;;;;;;;;OASG;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,152 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class CustomDomainsManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Delete a custom domain and stop serving requests for it.
|
|
9
|
+
* Delete custom domain configuration
|
|
10
|
+
*
|
|
11
|
+
* @throws {RequiredError}
|
|
12
|
+
*/
|
|
13
|
+
async delete(requestParameters, initOverrides) {
|
|
14
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
15
|
+
const response = await this.request({
|
|
16
|
+
path: `/custom-domains/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
17
|
+
method: 'DELETE',
|
|
18
|
+
}, initOverrides);
|
|
19
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Retrieve details on <a href="https://auth0.com/docs/custom-domains">custom domains</a>.
|
|
23
|
+
* Get custom domains configurations
|
|
24
|
+
*
|
|
25
|
+
* @throws {RequiredError}
|
|
26
|
+
*/
|
|
27
|
+
async getAll(initOverrides) {
|
|
28
|
+
const response = await this.request({
|
|
29
|
+
path: `/custom-domains`,
|
|
30
|
+
method: 'GET',
|
|
31
|
+
}, initOverrides);
|
|
32
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve a custom domain configuration and status.
|
|
36
|
+
* Get custom domain configuration
|
|
37
|
+
*
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
async get(requestParameters, initOverrides) {
|
|
41
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
42
|
+
const response = await this.request({
|
|
43
|
+
path: `/custom-domains/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
44
|
+
method: 'GET',
|
|
45
|
+
}, initOverrides);
|
|
46
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Update a custom domain.
|
|
50
|
+
*
|
|
51
|
+
* These are the attributes that can be updated:
|
|
52
|
+
*
|
|
53
|
+
* - custom_client_ip_header
|
|
54
|
+
* - tls_policy
|
|
55
|
+
*
|
|
56
|
+
* <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
|
|
57
|
+
* send should be:
|
|
58
|
+
* <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
|
|
59
|
+
*
|
|
60
|
+
* <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:
|
|
61
|
+
* <pre><code>{ "tls_policy": "compatible" }</code></pre>
|
|
62
|
+
*
|
|
63
|
+
*
|
|
64
|
+
* TLS Policies:
|
|
65
|
+
*
|
|
66
|
+
* - recommended - for modern usage this includes TLS 1.2 only
|
|
67
|
+
* - compatible - compatible with older browsers this policy includes TLS 1.0, 1.1, 1.2
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* Some considerations:
|
|
71
|
+
*
|
|
72
|
+
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
73
|
+
* - Do not use the <code>compatible</code> TLS policy unless you have clients that require TLS 1.0.
|
|
74
|
+
*
|
|
75
|
+
* Update custom domain configuration
|
|
76
|
+
*
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
async update(requestParameters, bodyParameters, initOverrides) {
|
|
80
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
81
|
+
const headerParameters = {};
|
|
82
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
83
|
+
const response = await this.request({
|
|
84
|
+
path: `/custom-domains/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
85
|
+
method: 'PATCH',
|
|
86
|
+
headers: headerParameters,
|
|
87
|
+
body: bodyParameters,
|
|
88
|
+
}, initOverrides);
|
|
89
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Create a new custom domain.
|
|
93
|
+
*
|
|
94
|
+
* Note: The custom domain will need to be verified before it will accept
|
|
95
|
+
* requests.
|
|
96
|
+
*
|
|
97
|
+
* Optional attributes that can be updated:
|
|
98
|
+
*
|
|
99
|
+
* - custom_client_ip_header
|
|
100
|
+
* - tls_policy
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* TLS Policies:
|
|
104
|
+
*
|
|
105
|
+
* - recommended - for modern usage this includes TLS 1.2 only
|
|
106
|
+
* - compatible - compatible with older browsers this policy includes TLS 1.0, 1.1, 1.2
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* Some considerations:
|
|
110
|
+
*
|
|
111
|
+
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
112
|
+
* - Do not use the <code>compatible</code> TLS policy unless you have clients that require TLS 1.0.
|
|
113
|
+
*
|
|
114
|
+
* Configure a new custom domain
|
|
115
|
+
*
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
async create(bodyParameters, initOverrides) {
|
|
119
|
+
const headerParameters = {};
|
|
120
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
121
|
+
const response = await this.request({
|
|
122
|
+
path: `/custom-domains`,
|
|
123
|
+
method: 'POST',
|
|
124
|
+
headers: headerParameters,
|
|
125
|
+
body: bodyParameters,
|
|
126
|
+
}, initOverrides);
|
|
127
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Run the verification process on a custom domain.
|
|
131
|
+
*
|
|
132
|
+
* 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.
|
|
133
|
+
*
|
|
134
|
+
* 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.
|
|
135
|
+
*
|
|
136
|
+
* <a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates.
|
|
137
|
+
* <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.
|
|
138
|
+
*
|
|
139
|
+
* Verify a custom domain
|
|
140
|
+
*
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
async verify(requestParameters, initOverrides) {
|
|
144
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
145
|
+
const response = await this.request({
|
|
146
|
+
path: `/custom-domains/{id}/verify`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
147
|
+
method: 'POST',
|
|
148
|
+
}, initOverrides);
|
|
149
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
//# sourceMappingURL=custom-domains-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"custom-domains-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/custom-domains-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAcnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,OAAO;IAC/C;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,iBAAiD,EACjD,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,sBAAsB,CAAC,OAAO,CAClC,MAAM,EACN,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CACjD;YACD,MAAM,EAAE,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,aAA4B;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,iBAAiB;YACvB,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,GAAG,CACP,iBAA8C,EAC9C,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,sBAAsB,CAAC,OAAO,CAClC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,MAAM,CACV,iBAAyD,EACzD,cAA6C,EAC7C,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,sBAAsB,CAAC,OAAO,CAClC,MAAM,EACN,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CACjD;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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,MAAM,CACV,cAAwC,EACxC,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,iBAAiB;YACvB,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;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACV,iBAAoC,EACpC,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,6BAA6B,CAAC,OAAO,CACzC,MAAM,EACN,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CACjD;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,85 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class DeviceCredentialsManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Delete a device credential.
|
|
9
|
+
* Delete a device credential
|
|
10
|
+
*
|
|
11
|
+
* @throws {RequiredError}
|
|
12
|
+
*/
|
|
13
|
+
async delete(requestParameters, initOverrides) {
|
|
14
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
15
|
+
const response = await this.request({
|
|
16
|
+
path: `/device-credentials/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
17
|
+
method: 'DELETE',
|
|
18
|
+
}, initOverrides);
|
|
19
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
20
|
+
}
|
|
21
|
+
async getAll(requestParameters = {}, initOverrides) {
|
|
22
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
23
|
+
{
|
|
24
|
+
key: 'page',
|
|
25
|
+
config: {},
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
key: 'per_page',
|
|
29
|
+
config: {},
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
key: 'include_totals',
|
|
33
|
+
config: {},
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
key: 'fields',
|
|
37
|
+
config: {},
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
key: 'include_fields',
|
|
41
|
+
config: {},
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
key: 'user_id',
|
|
45
|
+
config: {},
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
key: 'client_id',
|
|
49
|
+
config: {},
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
key: 'type',
|
|
53
|
+
config: {},
|
|
54
|
+
},
|
|
55
|
+
]);
|
|
56
|
+
const response = await this.request({
|
|
57
|
+
path: `/device-credentials`,
|
|
58
|
+
method: 'GET',
|
|
59
|
+
query: queryParameters,
|
|
60
|
+
}, initOverrides);
|
|
61
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Device Credentials relate to refresh tokens and rotating refresh tokens for a given user_id.
|
|
65
|
+
*
|
|
66
|
+
* Note: Device Credentials APIs are designed for ad-hoc administrative use only, and paging is by default enabled for GET requests.
|
|
67
|
+
* Note: When Refresh Token Rotation is enabled, the endpoint becomes eventual consistent.
|
|
68
|
+
*
|
|
69
|
+
* Create a device public key credential
|
|
70
|
+
*
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
*/
|
|
73
|
+
async createPublicKey(bodyParameters, initOverrides) {
|
|
74
|
+
const headerParameters = {};
|
|
75
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
76
|
+
const response = await this.request({
|
|
77
|
+
path: `/device-credentials`,
|
|
78
|
+
method: 'POST',
|
|
79
|
+
headers: headerParameters,
|
|
80
|
+
body: bodyParameters,
|
|
81
|
+
}, initOverrides);
|
|
82
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
//# sourceMappingURL=device-credentials-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"device-credentials-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/device-credentials-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAYnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,OAAO;IACnD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,iBAAqD,EACrD,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,QAAQ;SACjB,EACD,aAAa,CACd,CAAC;QAEF,OAAO,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IAoBD,KAAK,CAAC,MAAM,CACV,oBAAiD,EAAE,EACnD,aAA4B;QAE5B,MAAM,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,EAAE;YAClE;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,QAAQ;gBACb,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,gBAAgB;gBACrB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,SAAS;gBACd,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,EAAE;aACX;YACD;gBACE,GAAG,EAAE,MAAM;gBACX,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,qBAAqB;YAC3B,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;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CACnB,cAAsC,EACtC,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,qBAAqB;YAC3B,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,75 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class EmailTemplatesManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
|
|
9
|
+
* Get an email template
|
|
10
|
+
*
|
|
11
|
+
* @throws {RequiredError}
|
|
12
|
+
*/
|
|
13
|
+
async get(requestParameters, initOverrides) {
|
|
14
|
+
runtime.validateRequiredRequestParams(requestParameters, ['templateName']);
|
|
15
|
+
const response = await this.request({
|
|
16
|
+
path: `/email-templates/{templateName}`.replace('{templateName}', encodeURIComponent(String(requestParameters.templateName))),
|
|
17
|
+
method: 'GET',
|
|
18
|
+
}, initOverrides);
|
|
19
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Modify an email template.
|
|
23
|
+
* Patch an email template
|
|
24
|
+
*
|
|
25
|
+
* @throws {RequiredError}
|
|
26
|
+
*/
|
|
27
|
+
async update(requestParameters, bodyParameters, initOverrides) {
|
|
28
|
+
runtime.validateRequiredRequestParams(requestParameters, ['templateName']);
|
|
29
|
+
const headerParameters = {};
|
|
30
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
31
|
+
const response = await this.request({
|
|
32
|
+
path: `/email-templates/{templateName}`.replace('{templateName}', encodeURIComponent(String(requestParameters.templateName))),
|
|
33
|
+
method: 'PATCH',
|
|
34
|
+
headers: headerParameters,
|
|
35
|
+
body: bodyParameters,
|
|
36
|
+
}, initOverrides);
|
|
37
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Create an email template.
|
|
41
|
+
* Create an email template
|
|
42
|
+
*
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
async create(bodyParameters, initOverrides) {
|
|
46
|
+
const headerParameters = {};
|
|
47
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
48
|
+
const response = await this.request({
|
|
49
|
+
path: `/email-templates`,
|
|
50
|
+
method: 'POST',
|
|
51
|
+
headers: headerParameters,
|
|
52
|
+
body: bodyParameters,
|
|
53
|
+
}, initOverrides);
|
|
54
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Update an email template.
|
|
58
|
+
* Update an email template
|
|
59
|
+
*
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
async put(requestParameters, bodyParameters, initOverrides) {
|
|
63
|
+
runtime.validateRequiredRequestParams(requestParameters, ['templateName']);
|
|
64
|
+
const headerParameters = {};
|
|
65
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
66
|
+
const response = await this.request({
|
|
67
|
+
path: `/email-templates/{templateName}`.replace('{templateName}', encodeURIComponent(String(requestParameters.templateName))),
|
|
68
|
+
method: 'PUT',
|
|
69
|
+
headers: headerParameters,
|
|
70
|
+
body: bodyParameters,
|
|
71
|
+
}, initOverrides);
|
|
72
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=email-templates-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email-templates-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/email-templates-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAWnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,OAAO;IAChD;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,iBAAyD,EACzD,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,iCAAiC,CAAC,OAAO,CAC7C,gBAAgB,EAChB,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAC3D;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,MAAM,CACV,iBAA2D,EAC3D,cAA0D,EAC1D,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAE3E,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,iCAAiC,CAAC,OAAO,CAC7C,gBAAgB,EAChB,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAC3D;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;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,cAAyC,EACzC,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,kBAAkB;YACxB,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,GAAG,CACP,iBAAyD,EACzD,cAAmC,EACnC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAE3E,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,iCAAiC,CAAC,OAAO,CAC7C,gBAAgB,EAChB,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAC3D;YACD,MAAM,EAAE,KAAK;YACb,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,75 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class EmailsManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieve <a href="https://auth0.com/docs/email/providers">email provider</a> details. A list of fields to include or exclude may also be specified.
|
|
9
|
+
*
|
|
10
|
+
* Get the email provider
|
|
11
|
+
*
|
|
12
|
+
* @throws {RequiredError}
|
|
13
|
+
*/
|
|
14
|
+
async get(requestParameters = {}, initOverrides) {
|
|
15
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
16
|
+
{
|
|
17
|
+
key: 'fields',
|
|
18
|
+
config: {},
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
key: 'include_fields',
|
|
22
|
+
config: {},
|
|
23
|
+
},
|
|
24
|
+
]);
|
|
25
|
+
const response = await this.request({
|
|
26
|
+
path: `/emails/provider`,
|
|
27
|
+
method: 'GET',
|
|
28
|
+
query: queryParameters,
|
|
29
|
+
}, initOverrides);
|
|
30
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Update an <a href="https://auth0.com/docs/email/providers">email provider</a>.
|
|
34
|
+
* The <code>credentials</code> object requires different properties depending on the email provider (which is specified using the <code>name</code> property):
|
|
35
|
+
* <ul><li><code>mandrill</code> requires <code>api_key</code></li><li><code>sendgrid</code> requires <code>api_key</code></li><li><code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li><li><code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and <code>smtp_pass</code></li></ul>Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration options, which will be used when sending an email:
|
|
36
|
+
* <ul><li><code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object. When using AWS SES SMTP host, you may provide a name of configuration set in <code>X-SES-Configuration-Set</code> header. Value must be a string.</li><li>for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.</li></ul>
|
|
37
|
+
*
|
|
38
|
+
* Update the email provider
|
|
39
|
+
*
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
async update(bodyParameters, initOverrides) {
|
|
43
|
+
const headerParameters = {};
|
|
44
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
45
|
+
const response = await this.request({
|
|
46
|
+
path: `/emails/provider`,
|
|
47
|
+
method: 'PATCH',
|
|
48
|
+
headers: headerParameters,
|
|
49
|
+
body: bodyParameters,
|
|
50
|
+
}, initOverrides);
|
|
51
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Create an <a href="https://auth0.com/docs/email/providers">email provider</a>.
|
|
55
|
+
* The <code>credentials</code> object requires different properties depending on the email provider (which is specified using the <code>name</code> property):
|
|
56
|
+
* <ul><li><code>mandrill</code> requires <code>api_key</code></li><li><code>sendgrid</code> requires <code>api_key</code></li><li><code>sparkpost</code> requires <code>api_key</code>. Optionally, set <code>region</code> to <code>eu</code> to use the SparkPost service hosted in Western Europe; set to <code>null</code> to use the SparkPost service hosted in North America. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>mailgun</code> requires <code>api_key</code> and <code>domain</code>. Optionally, set <code>region</code> to <code>eu</code> to use the Mailgun service hosted in Europe; set to <code>null</code> otherwise. <code>eu</code> or <code>null</code> are the only valid values for <code>region</code>.</li><li><code>ses</code> requires <code>accessKeyId</code>, <code>secretAccessKey</code>, and <code>region</code></li><li><code>smtp</code> requires <code>smtp_host</code>, <code>smtp_port</code>, <code>smtp_user</code>, and <code>smtp_pass</code></li></ul>Depending on the type of provider it is possible to specify <code>settings</code> object with different configuration options, which will be used when sending an email:
|
|
57
|
+
* <ul><li><code>smtp</code> provider, <code>settings</code> may contain <code>headers</code> object. When using AWS SES SMTP host, you may provide a name of configuration set in <code>X-SES-Configuration-Set</code> header. Value must be a string.</li><li>for <code>ses</code> provider, <code>settings</code> may contain <code>message</code> object, where you can provide a name of configuration set in <code>configuration_set_name</code> property. Value must be a string.</li></ul>
|
|
58
|
+
*
|
|
59
|
+
* Configure the email provider
|
|
60
|
+
*
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
async configure(bodyParameters, initOverrides) {
|
|
64
|
+
const headerParameters = {};
|
|
65
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
66
|
+
const response = await this.request({
|
|
67
|
+
path: `/emails/provider`,
|
|
68
|
+
method: 'POST',
|
|
69
|
+
headers: headerParameters,
|
|
70
|
+
body: bodyParameters,
|
|
71
|
+
}, initOverrides);
|
|
72
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
//# sourceMappingURL=emails-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"emails-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/emails-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AASnD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CACP,oBAAwC,EAAE,EAC1C,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;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,kBAAkB;YACxB,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;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CACV,cAAoC,EACpC,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,kBAAkB;YACxB,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;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CACb,cAAmC,EACnC,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,kBAAkB;YACxB,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"}
|