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,42 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class UsersByEmailManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* If Auth0 is the identify provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. For example, if you register a user as <b>JohnSmith@example.com</b>, Auth0 saves the user's email as <b>johnsmith@example.com</b>.
|
|
9
|
+
*
|
|
10
|
+
* In cases where Auth0 is not the idP, the `email` is stored based on the rules of idP, so make sure the search is made using the correct capitalization.
|
|
11
|
+
*
|
|
12
|
+
* When using this endpoint, make sure that you are searching for users via email addresses using the correct case.
|
|
13
|
+
*
|
|
14
|
+
* Search Users by Email
|
|
15
|
+
*
|
|
16
|
+
* @throws {RequiredError}
|
|
17
|
+
*/
|
|
18
|
+
async getByEmail(requestParameters, initOverrides) {
|
|
19
|
+
runtime.validateRequiredRequestParams(requestParameters, ['email']);
|
|
20
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
21
|
+
{
|
|
22
|
+
key: 'fields',
|
|
23
|
+
config: {},
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
key: 'include_fields',
|
|
27
|
+
config: {},
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
key: 'email',
|
|
31
|
+
config: {},
|
|
32
|
+
},
|
|
33
|
+
]);
|
|
34
|
+
const response = await this.request({
|
|
35
|
+
path: `/users-by-email`,
|
|
36
|
+
method: 'GET',
|
|
37
|
+
query: queryParameters,
|
|
38
|
+
}, initOverrides);
|
|
39
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=users-by-email-manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"users-by-email-manager.js","sourceRoot":"","sources":["../../../../../src/management/__generated/managers/users-by-email-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AAInD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,OAAO;IAC9C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,UAAU,CACd,iBAAyC,EACzC,aAA4B;QAE5B,OAAO,CAAC,6BAA6B,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpE,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,OAAO;gBACZ,MAAM,EAAE,EAAE;aACX;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC;YACE,IAAI,EAAE,iBAAiB;YACvB,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;CACF"}
|
|
@@ -0,0 +1,607 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
const { BaseAPI } = runtime;
|
|
3
|
+
/**
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export class UsersManager extends BaseAPI {
|
|
7
|
+
/**
|
|
8
|
+
* Deletes an authentication method by ID
|
|
9
|
+
*
|
|
10
|
+
* @throws {RequiredError}
|
|
11
|
+
*/
|
|
12
|
+
async deleteAuthenticationMethod(requestParameters, initOverrides) {
|
|
13
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id', 'authentication_method_id']);
|
|
14
|
+
const response = await this.request({
|
|
15
|
+
path: `/users/{id}/authentication-methods/{authentication_method_id}`
|
|
16
|
+
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
|
|
17
|
+
.replace('{authentication_method_id}', encodeURIComponent(String(requestParameters.authentication_method_id))),
|
|
18
|
+
method: 'DELETE',
|
|
19
|
+
}, initOverrides);
|
|
20
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Delete All Authenticators
|
|
24
|
+
*
|
|
25
|
+
* @throws {RequiredError}
|
|
26
|
+
*/
|
|
27
|
+
async deleteAllAuthenticators(requestParameters, initOverrides) {
|
|
28
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
29
|
+
const response = await this.request({
|
|
30
|
+
path: `/users/{id}/authenticators`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
31
|
+
method: 'DELETE',
|
|
32
|
+
}, initOverrides);
|
|
33
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Delete a <a href="https://auth0.com/docs/multifactor-authentication">multifactor</a> configuration for a user. This forces the user to re-configure the multi-factor provider.
|
|
37
|
+
* Delete a User's Multi-factor Provider
|
|
38
|
+
*
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
async deleteMultifactorProvider(requestParameters, initOverrides) {
|
|
42
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id', 'provider']);
|
|
43
|
+
const response = await this.request({
|
|
44
|
+
path: `/users/{id}/multifactor/{provider}`
|
|
45
|
+
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
|
|
46
|
+
.replace('{provider}', encodeURIComponent(String(requestParameters.provider))),
|
|
47
|
+
method: 'DELETE',
|
|
48
|
+
}, initOverrides);
|
|
49
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Remove permissions from a user.
|
|
53
|
+
*
|
|
54
|
+
* Remove Permissions from a User
|
|
55
|
+
*
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
async deletePermissions(requestParameters, bodyParameters, initOverrides) {
|
|
59
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
60
|
+
const headerParameters = {};
|
|
61
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
62
|
+
const response = await this.request({
|
|
63
|
+
path: `/users/{id}/permissions`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
64
|
+
method: 'DELETE',
|
|
65
|
+
headers: headerParameters,
|
|
66
|
+
body: bodyParameters,
|
|
67
|
+
}, initOverrides);
|
|
68
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Unlink an identity from the target user making it a separate user account again.
|
|
72
|
+
* Unlink a User Identity
|
|
73
|
+
*
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
async unlink(requestParameters, initOverrides) {
|
|
77
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id', 'provider', 'user_id']);
|
|
78
|
+
const response = await this.request({
|
|
79
|
+
path: `/users/{id}/identities/{provider}/{user_id}`
|
|
80
|
+
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
|
|
81
|
+
.replace('{provider}', encodeURIComponent(String(requestParameters.provider)))
|
|
82
|
+
.replace('{user_id}', encodeURIComponent(String(requestParameters.user_id))),
|
|
83
|
+
method: 'DELETE',
|
|
84
|
+
}, initOverrides);
|
|
85
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Remove roles from a user.
|
|
89
|
+
* Removes roles from a user
|
|
90
|
+
*
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
async deleteRoles(requestParameters, bodyParameters, initOverrides) {
|
|
94
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
95
|
+
const headerParameters = {};
|
|
96
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
97
|
+
const response = await this.request({
|
|
98
|
+
path: `/users/{id}/roles`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
99
|
+
method: 'DELETE',
|
|
100
|
+
headers: headerParameters,
|
|
101
|
+
body: bodyParameters,
|
|
102
|
+
}, initOverrides);
|
|
103
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Delete a user.
|
|
107
|
+
* Delete a User
|
|
108
|
+
*
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
async delete(requestParameters, initOverrides) {
|
|
112
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
113
|
+
const response = await this.request({
|
|
114
|
+
path: `/users/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
115
|
+
method: 'DELETE',
|
|
116
|
+
}, initOverrides);
|
|
117
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
118
|
+
}
|
|
119
|
+
async getAuthenticationMethods(requestParameters, initOverrides) {
|
|
120
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
121
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
122
|
+
{
|
|
123
|
+
key: 'page',
|
|
124
|
+
config: {},
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
key: 'per_page',
|
|
128
|
+
config: {},
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
key: 'include_totals',
|
|
132
|
+
config: {},
|
|
133
|
+
},
|
|
134
|
+
]);
|
|
135
|
+
const response = await this.request({
|
|
136
|
+
path: `/users/{id}/authentication-methods`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
137
|
+
method: 'GET',
|
|
138
|
+
query: queryParameters,
|
|
139
|
+
}, initOverrides);
|
|
140
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Gets an authentication method by ID.
|
|
144
|
+
*
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
async getAuthenticationMethod(requestParameters, initOverrides) {
|
|
148
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id', 'authentication_method_id']);
|
|
149
|
+
const response = await this.request({
|
|
150
|
+
path: `/users/{id}/authentication-methods/{authentication_method_id}`
|
|
151
|
+
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
|
|
152
|
+
.replace('{authentication_method_id}', encodeURIComponent(String(requestParameters.authentication_method_id))),
|
|
153
|
+
method: 'GET',
|
|
154
|
+
}, initOverrides);
|
|
155
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Retrieve the first confirmed <a href="https://auth0.com/docs/multifactor-authentication/guardian">Guardian</a> enrollment for a user.
|
|
159
|
+
* Get the First Confirmed Multi-factor Authentication Enrollment
|
|
160
|
+
*
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
async getEnrollments(requestParameters, initOverrides) {
|
|
164
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
165
|
+
const response = await this.request({
|
|
166
|
+
path: `/users/{id}/enrollments`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
167
|
+
method: 'GET',
|
|
168
|
+
}, initOverrides);
|
|
169
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
170
|
+
}
|
|
171
|
+
async getLogs(requestParameters, initOverrides) {
|
|
172
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
173
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
174
|
+
{
|
|
175
|
+
key: 'page',
|
|
176
|
+
config: {},
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
key: 'per_page',
|
|
180
|
+
config: {},
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
key: 'sort',
|
|
184
|
+
config: {},
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
key: 'include_totals',
|
|
188
|
+
config: {},
|
|
189
|
+
},
|
|
190
|
+
]);
|
|
191
|
+
const response = await this.request({
|
|
192
|
+
path: `/users/{id}/logs`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
193
|
+
method: 'GET',
|
|
194
|
+
query: queryParameters,
|
|
195
|
+
}, initOverrides);
|
|
196
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
197
|
+
}
|
|
198
|
+
async getPermissions(requestParameters, initOverrides) {
|
|
199
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
200
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
201
|
+
{
|
|
202
|
+
key: 'per_page',
|
|
203
|
+
config: {},
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
key: 'page',
|
|
207
|
+
config: {},
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
key: 'include_totals',
|
|
211
|
+
config: {},
|
|
212
|
+
},
|
|
213
|
+
]);
|
|
214
|
+
const response = await this.request({
|
|
215
|
+
path: `/users/{id}/permissions`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
216
|
+
method: 'GET',
|
|
217
|
+
query: queryParameters,
|
|
218
|
+
}, initOverrides);
|
|
219
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
220
|
+
}
|
|
221
|
+
async getUserOrganizations(requestParameters, initOverrides) {
|
|
222
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
223
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
224
|
+
{
|
|
225
|
+
key: 'page',
|
|
226
|
+
config: {},
|
|
227
|
+
},
|
|
228
|
+
{
|
|
229
|
+
key: 'per_page',
|
|
230
|
+
config: {},
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
key: 'include_totals',
|
|
234
|
+
config: {},
|
|
235
|
+
},
|
|
236
|
+
]);
|
|
237
|
+
const response = await this.request({
|
|
238
|
+
path: `/users/{id}/organizations`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
239
|
+
method: 'GET',
|
|
240
|
+
query: queryParameters,
|
|
241
|
+
}, initOverrides);
|
|
242
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
243
|
+
}
|
|
244
|
+
async getRoles(requestParameters, initOverrides) {
|
|
245
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
246
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
247
|
+
{
|
|
248
|
+
key: 'per_page',
|
|
249
|
+
config: {},
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
key: 'page',
|
|
253
|
+
config: {},
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
key: 'include_totals',
|
|
257
|
+
config: {},
|
|
258
|
+
},
|
|
259
|
+
]);
|
|
260
|
+
const response = await this.request({
|
|
261
|
+
path: `/users/{id}/roles`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
262
|
+
method: 'GET',
|
|
263
|
+
query: queryParameters,
|
|
264
|
+
}, initOverrides);
|
|
265
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
266
|
+
}
|
|
267
|
+
async getAll(requestParameters = {}, initOverrides) {
|
|
268
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
269
|
+
{
|
|
270
|
+
key: 'page',
|
|
271
|
+
config: {},
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
key: 'per_page',
|
|
275
|
+
config: {},
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
key: 'include_totals',
|
|
279
|
+
config: {},
|
|
280
|
+
},
|
|
281
|
+
{
|
|
282
|
+
key: 'sort',
|
|
283
|
+
config: {},
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
key: 'connection',
|
|
287
|
+
config: {},
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
key: 'fields',
|
|
291
|
+
config: {},
|
|
292
|
+
},
|
|
293
|
+
{
|
|
294
|
+
key: 'include_fields',
|
|
295
|
+
config: {},
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
key: 'q',
|
|
299
|
+
config: {},
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
key: 'search_engine',
|
|
303
|
+
config: {},
|
|
304
|
+
},
|
|
305
|
+
]);
|
|
306
|
+
const response = await this.request({
|
|
307
|
+
path: `/users`,
|
|
308
|
+
method: 'GET',
|
|
309
|
+
query: queryParameters,
|
|
310
|
+
}, initOverrides);
|
|
311
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* Retrieve user details. A list of fields to include or exclude may also be specified.
|
|
315
|
+
* Get a User
|
|
316
|
+
*
|
|
317
|
+
* @throws {RequiredError}
|
|
318
|
+
*/
|
|
319
|
+
async get(requestParameters, initOverrides) {
|
|
320
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
321
|
+
const queryParameters = runtime.applyQueryParams(requestParameters, [
|
|
322
|
+
{
|
|
323
|
+
key: 'fields',
|
|
324
|
+
config: {},
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
key: 'include_fields',
|
|
328
|
+
config: {},
|
|
329
|
+
},
|
|
330
|
+
]);
|
|
331
|
+
const response = await this.request({
|
|
332
|
+
path: `/users/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
333
|
+
method: 'GET',
|
|
334
|
+
query: queryParameters,
|
|
335
|
+
}, initOverrides);
|
|
336
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* Updates an authentication method.
|
|
340
|
+
*
|
|
341
|
+
* @throws {RequiredError}
|
|
342
|
+
*/
|
|
343
|
+
async updateAuthenticationMethod(requestParameters, bodyParameters, initOverrides) {
|
|
344
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id', 'authentication_method_id']);
|
|
345
|
+
const headerParameters = {};
|
|
346
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
347
|
+
const response = await this.request({
|
|
348
|
+
path: `/users/{id}/authentication-methods/{authentication_method_id}`
|
|
349
|
+
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
|
|
350
|
+
.replace('{authentication_method_id}', encodeURIComponent(String(requestParameters.authentication_method_id))),
|
|
351
|
+
method: 'PATCH',
|
|
352
|
+
headers: headerParameters,
|
|
353
|
+
body: bodyParameters,
|
|
354
|
+
}, initOverrides);
|
|
355
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* Update a user.
|
|
359
|
+
*
|
|
360
|
+
* These are the attributes that can be updated at the root level:
|
|
361
|
+
*
|
|
362
|
+
* <ul>
|
|
363
|
+
* <li>app_metadata</li>
|
|
364
|
+
* <li>blocked</li>
|
|
365
|
+
* <li>email</li>
|
|
366
|
+
* <li>email_verified</li>
|
|
367
|
+
* <li>family_name</li>
|
|
368
|
+
* <li>given_name</li>
|
|
369
|
+
* <li>name</li>
|
|
370
|
+
* <li>nickname</li>
|
|
371
|
+
* <li>password</li>
|
|
372
|
+
* <li>phone_number</li>
|
|
373
|
+
* <li>phone_verified</li>
|
|
374
|
+
* <li>picture</li>
|
|
375
|
+
* <li>username</li>
|
|
376
|
+
* <li>user_metadata</li>
|
|
377
|
+
* <li>verify_email</li>
|
|
378
|
+
* </ul>
|
|
379
|
+
*
|
|
380
|
+
* Some considerations:
|
|
381
|
+
* <ul>
|
|
382
|
+
* <li>The properties of the new object will replace the old ones.</li>
|
|
383
|
+
* <li>The metadata fields are an exception to this rule (<code>user_metadata</code> and <code>app_metadata</code>). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.</li>
|
|
384
|
+
* <li>If you are updating <code>email</code>, <code>email_verified</code>, <code>phone_number</code>, <code>phone_verified</code>, <code>username</code> or <code>password</code> of a secondary identity, you need to specify the <code>connection</code> property too.</li>
|
|
385
|
+
* <li>If you are updating <code>email</code> or <code>phone_number</code> you can specify, optionally, the <code>client_id</code> property.</li>
|
|
386
|
+
* <li>Updating <code>email_verified</code> is not supported for enterprise and passwordless sms connections.</li>
|
|
387
|
+
* <li>Updating the <code>blocked</code> to <code>false</code> does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.</li>
|
|
388
|
+
* </ul>
|
|
389
|
+
*
|
|
390
|
+
* <h5>Updating a field (non-metadata property)</h5>
|
|
391
|
+
* To mark the email address of a user as verified, the body to send should be:
|
|
392
|
+
* <pre><code>{ "email_verified": true }</code></pre>
|
|
393
|
+
*
|
|
394
|
+
* <h5>Updating a user metadata root property</h5>Let's assume that our test user has the following <code>user_metadata</code>:
|
|
395
|
+
* <pre><code>{ "user_metadata" : { "profileCode": 1479 } }</code></pre>
|
|
396
|
+
*
|
|
397
|
+
* To add the field <code>addresses</code> the body to send should be:
|
|
398
|
+
* <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
|
|
399
|
+
*
|
|
400
|
+
* The modified object ends up with the following <code>user_metadata</code> property:<pre><code>{
|
|
401
|
+
* "user_metadata": {
|
|
402
|
+
* "profileCode": 1479,
|
|
403
|
+
* "addresses": { "work_address": "100 Industrial Way" }
|
|
404
|
+
* }
|
|
405
|
+
* }</code></pre>
|
|
406
|
+
*
|
|
407
|
+
* <h5>Updating an inner user metadata property</h5>If there's existing user metadata to which we want to add <code>"home_address": "742 Evergreen Terrace"</code> (using the <code>addresses</code> property) we should send the whole <code>addresses</code> object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
|
|
408
|
+
* <pre><code>{
|
|
409
|
+
* "user_metadata": {
|
|
410
|
+
* "addresses": {
|
|
411
|
+
* "work_address": "100 Industrial Way",
|
|
412
|
+
* "home_address": "742 Evergreen Terrace"
|
|
413
|
+
* }
|
|
414
|
+
* }
|
|
415
|
+
* }</code></pre>
|
|
416
|
+
*
|
|
417
|
+
* The modified object ends up with the following <code>user_metadata</code> property:
|
|
418
|
+
* <pre><code>{
|
|
419
|
+
* "user_metadata": {
|
|
420
|
+
* "profileCode": 1479,
|
|
421
|
+
* "addresses": {
|
|
422
|
+
* "work_address": "100 Industrial Way",
|
|
423
|
+
* "home_address": "742 Evergreen Terrace"
|
|
424
|
+
* }
|
|
425
|
+
* }
|
|
426
|
+
* }</code></pre>
|
|
427
|
+
*
|
|
428
|
+
* Update a User
|
|
429
|
+
*
|
|
430
|
+
* @throws {RequiredError}
|
|
431
|
+
*/
|
|
432
|
+
async update(requestParameters, bodyParameters, initOverrides) {
|
|
433
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
434
|
+
const headerParameters = {};
|
|
435
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
436
|
+
const response = await this.request({
|
|
437
|
+
path: `/users/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
438
|
+
method: 'PATCH',
|
|
439
|
+
headers: headerParameters,
|
|
440
|
+
body: bodyParameters,
|
|
441
|
+
}, initOverrides);
|
|
442
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* Creates an authentication method for a given user.
|
|
446
|
+
*
|
|
447
|
+
* @throws {RequiredError}
|
|
448
|
+
*/
|
|
449
|
+
async createAuthenticationMethod(requestParameters, bodyParameters, initOverrides) {
|
|
450
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
451
|
+
const headerParameters = {};
|
|
452
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
453
|
+
const response = await this.request({
|
|
454
|
+
path: `/users/{id}/authentication-methods`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
455
|
+
method: 'POST',
|
|
456
|
+
headers: headerParameters,
|
|
457
|
+
body: bodyParameters,
|
|
458
|
+
}, initOverrides);
|
|
459
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.
|
|
463
|
+
*
|
|
464
|
+
* Note: There are two ways of invoking the endpoint:
|
|
465
|
+
*
|
|
466
|
+
* <ul>
|
|
467
|
+
* <li>With the authenticated primary account's JWT in the Authorization header, which has the <code>update:current_user_identities</code> scope:
|
|
468
|
+
* <pre>
|
|
469
|
+
* POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
|
|
470
|
+
* Authorization: "Bearer PRIMARY_ACCOUNT_JWT"
|
|
471
|
+
* {
|
|
472
|
+
* "link_with": "SECONDARY_ACCOUNT_JWT"
|
|
473
|
+
* }
|
|
474
|
+
* </pre>
|
|
475
|
+
* In this case, only the <code>link_with</code> param is required in the body, which also contains the JWT obtained upon the secondary account's authentication.
|
|
476
|
+
* </li>
|
|
477
|
+
* <li>With a token generated by the API V2 containing the <code>update:users</code> scope:
|
|
478
|
+
* <pre>
|
|
479
|
+
* POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
|
|
480
|
+
* Authorization: "Bearer YOUR_API_V2_TOKEN"
|
|
481
|
+
* {
|
|
482
|
+
* "provider": "SECONDARY_ACCOUNT_PROVIDER",
|
|
483
|
+
* "connection_id": "SECONDARY_ACCOUNT_CONNECTION_ID(OPTIONAL)",
|
|
484
|
+
* "user_id": "SECONDARY_ACCOUNT_USER_ID"
|
|
485
|
+
* }
|
|
486
|
+
* </pre>
|
|
487
|
+
* In this case you need to send <code>provider</code> and <code>user_id</code> in the body. Optionally you can also send the <code>connection_id</code> param which is suitable for identifying a particular database connection for the 'auth0' provider.
|
|
488
|
+
* </li>
|
|
489
|
+
* </ul>
|
|
490
|
+
* Link a User Account
|
|
491
|
+
*
|
|
492
|
+
* @throws {RequiredError}
|
|
493
|
+
*/
|
|
494
|
+
async link(requestParameters, bodyParameters, initOverrides) {
|
|
495
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
496
|
+
const headerParameters = {};
|
|
497
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
498
|
+
const response = await this.request({
|
|
499
|
+
path: `/users/{id}/identities`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
500
|
+
method: 'POST',
|
|
501
|
+
headers: headerParameters,
|
|
502
|
+
body: bodyParameters,
|
|
503
|
+
}, initOverrides);
|
|
504
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* Invalidate all remembered browsers across all <a href="https://auth0.com/docs/multifactor-authentication">authentication factors</a> for a user.
|
|
508
|
+
* Invalidate All Remembered Browsers for Multi-factor Authentication
|
|
509
|
+
*
|
|
510
|
+
* @throws {RequiredError}
|
|
511
|
+
*/
|
|
512
|
+
async invalidateRememberBrowser(requestParameters, initOverrides) {
|
|
513
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
514
|
+
const response = await this.request({
|
|
515
|
+
path: `/users/{id}/multifactor/actions/invalidate-remember-browser`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
516
|
+
method: 'POST',
|
|
517
|
+
}, initOverrides);
|
|
518
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Assign permissions to a user.
|
|
522
|
+
* Assign Permissions to a User
|
|
523
|
+
*
|
|
524
|
+
* @throws {RequiredError}
|
|
525
|
+
*/
|
|
526
|
+
async assignPermissions(requestParameters, bodyParameters, initOverrides) {
|
|
527
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
528
|
+
const headerParameters = {};
|
|
529
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
530
|
+
const response = await this.request({
|
|
531
|
+
path: `/users/{id}/permissions`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
532
|
+
method: 'POST',
|
|
533
|
+
headers: headerParameters,
|
|
534
|
+
body: bodyParameters,
|
|
535
|
+
}, initOverrides);
|
|
536
|
+
return runtime.TextApiResponse.fromResponse(response);
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* Remove the current <a href="https://auth0.com/docs/multifactor-authentication/guardian">multi-factor authentication</a> recovery code and generate a new one.
|
|
540
|
+
* Generate New Multi-factor Authentication Recovery Code
|
|
541
|
+
*
|
|
542
|
+
* @throws {RequiredError}
|
|
543
|
+
*/
|
|
544
|
+
async regenerateRecoveryCode(requestParameters, initOverrides) {
|
|
545
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
546
|
+
const response = await this.request({
|
|
547
|
+
path: `/users/{id}/recovery-code-regeneration`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
548
|
+
method: 'POST',
|
|
549
|
+
}, initOverrides);
|
|
550
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Associate roles with a user.
|
|
554
|
+
* Assign roles to a user
|
|
555
|
+
*
|
|
556
|
+
* @throws {RequiredError}
|
|
557
|
+
*/
|
|
558
|
+
async assignRoles(requestParameters, bodyParameters, initOverrides) {
|
|
559
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
560
|
+
const headerParameters = {};
|
|
561
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
562
|
+
const response = await this.request({
|
|
563
|
+
path: `/users/{id}/roles`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
564
|
+
method: 'POST',
|
|
565
|
+
headers: headerParameters,
|
|
566
|
+
body: bodyParameters,
|
|
567
|
+
}, initOverrides);
|
|
568
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* Create a new user for a given <a href="https://auth0.com/docs/connections/database">database</a> or <a href="https://auth0.com/docs/connections/passwordless">passwordless</a> connection.
|
|
572
|
+
*
|
|
573
|
+
* Note: <code>connection</code> is required but other parameters such as <code>email</code> and <code>password</code> are dependent upon the type of connection.
|
|
574
|
+
* Create a User
|
|
575
|
+
*
|
|
576
|
+
* @throws {RequiredError}
|
|
577
|
+
*/
|
|
578
|
+
async create(bodyParameters, initOverrides) {
|
|
579
|
+
const headerParameters = {};
|
|
580
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
581
|
+
const response = await this.request({
|
|
582
|
+
path: `/users`,
|
|
583
|
+
method: 'POST',
|
|
584
|
+
headers: headerParameters,
|
|
585
|
+
body: bodyParameters,
|
|
586
|
+
}, initOverrides);
|
|
587
|
+
return runtime.JSONApiResponse.fromResponse(response);
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* Updates all authentication methods by replacing them with the given ones.
|
|
591
|
+
*
|
|
592
|
+
* @throws {RequiredError}
|
|
593
|
+
*/
|
|
594
|
+
async updateAuthenticationMethods(requestParameters, bodyParameters, initOverrides) {
|
|
595
|
+
runtime.validateRequiredRequestParams(requestParameters, ['id']);
|
|
596
|
+
const headerParameters = {};
|
|
597
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
598
|
+
const response = await this.request({
|
|
599
|
+
path: `/users/{id}/authentication-methods`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
|
|
600
|
+
method: 'PUT',
|
|
601
|
+
headers: headerParameters,
|
|
602
|
+
body: bodyParameters,
|
|
603
|
+
}, initOverrides);
|
|
604
|
+
return runtime.VoidApiResponse.fromResponse(response);
|
|
605
|
+
}
|
|
606
|
+
}
|
|
607
|
+
//# sourceMappingURL=users-manager.js.map
|