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,71 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Connection, ConnectionCreate, ConnectionUpdate, GetConnections200ResponseOneOf, DeleteConnectionsByIdRequest, DeleteUsersByEmailRequest, GetConnectionsRequest, GetConnectionsByIdRequest, GetStatusRequest, PatchConnectionsByIdRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ConnectionsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Deletes a connection and all its users.
|
|
11
|
+
*
|
|
12
|
+
* Delete a connection
|
|
13
|
+
*
|
|
14
|
+
* @throws {RequiredError}
|
|
15
|
+
*/
|
|
16
|
+
delete(requestParameters: DeleteConnectionsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
17
|
+
/**
|
|
18
|
+
* Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
|
|
19
|
+
*
|
|
20
|
+
* Delete a connection user
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
*/
|
|
24
|
+
deleteUserByEmail(requestParameters: DeleteUsersByEmailRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
25
|
+
/**
|
|
26
|
+
* Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
|
|
27
|
+
*
|
|
28
|
+
* Get all connections
|
|
29
|
+
*
|
|
30
|
+
* @throws {RequiredError}
|
|
31
|
+
*/
|
|
32
|
+
getAll(requestParameters: GetConnectionsRequest & {
|
|
33
|
+
include_totals: true;
|
|
34
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetConnections200ResponseOneOf>>;
|
|
35
|
+
getAll(requestParameters?: GetConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Connection>>>;
|
|
36
|
+
/**
|
|
37
|
+
* Retrieves a connection by its <code>ID</code>.
|
|
38
|
+
*
|
|
39
|
+
* Get a connection
|
|
40
|
+
*
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
get(requestParameters: GetConnectionsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
44
|
+
/**
|
|
45
|
+
* 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
|
|
46
|
+
* Check connection status
|
|
47
|
+
*
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
checkStatus(requestParameters: GetStatusRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
51
|
+
/**
|
|
52
|
+
* <b>Note:</b> if you use the options parameter, the whole options object will be overridden, so ensure that all parameters are present
|
|
53
|
+
*
|
|
54
|
+
* Update a connection
|
|
55
|
+
*
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
update(requestParameters: PatchConnectionsByIdRequest, bodyParameters: ConnectionUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
59
|
+
/**
|
|
60
|
+
* Creates a new connection according to the JSON object received in <code>body</code>.
|
|
61
|
+
* The samples on the right show all available attributes. Mandatory attributes are <code>name</code> and <code>strategy</code>.
|
|
62
|
+
* 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>
|
|
63
|
+
*
|
|
64
|
+
* <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>
|
|
65
|
+
* Create a connection
|
|
66
|
+
*
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
create(bodyParameters: ConnectionCreate, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
70
|
+
}
|
|
71
|
+
export {};
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { CustomDomain, PatchCustomDomainsByIdRequest, PostCustomDomains201Response, PostCustomDomainsRequest, PostVerify200Response, DeleteCustomDomainsByIdRequest, GetCustomDomainsByIdRequest, PatchCustomDomainsByIdOperationRequest, PostVerifyRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class CustomDomainsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a custom domain and stop serving requests for it.
|
|
11
|
+
* Delete custom domain configuration
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteCustomDomainsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve details on <a href="https://auth0.com/docs/custom-domains">custom domains</a>.
|
|
18
|
+
* Get custom domains configurations
|
|
19
|
+
*
|
|
20
|
+
* @throws {RequiredError}
|
|
21
|
+
*/
|
|
22
|
+
getAll(initOverrides?: InitOverride): Promise<ApiResponse<Array<CustomDomain>>>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieve a custom domain configuration and status.
|
|
25
|
+
* Get custom domain configuration
|
|
26
|
+
*
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
get(requestParameters: GetCustomDomainsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<CustomDomain>>;
|
|
30
|
+
/**
|
|
31
|
+
* Update a custom domain.
|
|
32
|
+
*
|
|
33
|
+
* These are the attributes that can be updated:
|
|
34
|
+
*
|
|
35
|
+
* - custom_client_ip_header
|
|
36
|
+
* - tls_policy
|
|
37
|
+
*
|
|
38
|
+
* <h5>Updating CUSTOM_CLIENT_IP_HEADER for a custom domain</h5>To update the <code>custom_client_ip_header</code> for a domain, the body to
|
|
39
|
+
* send should be:
|
|
40
|
+
* <pre><code>{ "custom_client_ip_header": "cf-connecting-ip" }</code></pre>
|
|
41
|
+
*
|
|
42
|
+
* <h5>Updating TLS_POLICY for a custom domain</h5>To update the <code>tls_policy</code> for a domain, the body to send should be:
|
|
43
|
+
* <pre><code>{ "tls_policy": "compatible" }</code></pre>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* TLS Policies:
|
|
47
|
+
*
|
|
48
|
+
* - recommended - for modern usage this includes TLS 1.2 only
|
|
49
|
+
* - compatible - compatible with older browsers this policy includes TLS 1.0, 1.1, 1.2
|
|
50
|
+
*
|
|
51
|
+
*
|
|
52
|
+
* Some considerations:
|
|
53
|
+
*
|
|
54
|
+
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
55
|
+
* - Do not use the <code>compatible</code> TLS policy unless you have clients that require TLS 1.0.
|
|
56
|
+
*
|
|
57
|
+
* Update custom domain configuration
|
|
58
|
+
*
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
*/
|
|
61
|
+
update(requestParameters: PatchCustomDomainsByIdOperationRequest, bodyParameters: PatchCustomDomainsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostCustomDomains201Response>>;
|
|
62
|
+
/**
|
|
63
|
+
* Create a new custom domain.
|
|
64
|
+
*
|
|
65
|
+
* Note: The custom domain will need to be verified before it will accept
|
|
66
|
+
* requests.
|
|
67
|
+
*
|
|
68
|
+
* Optional attributes that can be updated:
|
|
69
|
+
*
|
|
70
|
+
* - custom_client_ip_header
|
|
71
|
+
* - tls_policy
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* TLS Policies:
|
|
75
|
+
*
|
|
76
|
+
* - recommended - for modern usage this includes TLS 1.2 only
|
|
77
|
+
* - compatible - compatible with older browsers this policy includes TLS 1.0, 1.1, 1.2
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* Some considerations:
|
|
81
|
+
*
|
|
82
|
+
* - The TLS ciphers and protocols available in each TLS policy follow industry recommendations, and may be updated occasionally.
|
|
83
|
+
* - Do not use the <code>compatible</code> TLS policy unless you have clients that require TLS 1.0.
|
|
84
|
+
*
|
|
85
|
+
* Configure a new custom domain
|
|
86
|
+
*
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
create(bodyParameters: PostCustomDomainsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostCustomDomains201Response>>;
|
|
90
|
+
/**
|
|
91
|
+
* Run the verification process on a custom domain.
|
|
92
|
+
*
|
|
93
|
+
* Note: Check the <code>status</code> field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.
|
|
94
|
+
*
|
|
95
|
+
* For <code>self_managed_certs</code>, when the custom domain is verified for the first time, the response will also include the <code>cname_api_key</code> which you will need to configure your proxy. This key must be kept secret, and is used to validate the proxy requests.
|
|
96
|
+
*
|
|
97
|
+
* <a href="https://auth0.com/docs/custom-domains#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Auth0 Managed certificates.
|
|
98
|
+
* <a href="https://auth0.com/docs/custom-domains/self-managed-certificates#step-2-verify-ownership">Learn more</a> about verifying custom domains that use Self Managed certificates.
|
|
99
|
+
*
|
|
100
|
+
* Verify a custom domain
|
|
101
|
+
*
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
verify(requestParameters: PostVerifyRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostVerify200Response>>;
|
|
105
|
+
}
|
|
106
|
+
export {};
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { DeviceCredentialCreate, PostDeviceCredentials201Response, GetDeviceCredentials200ResponseOneOf, DeviceCredential, DeleteDeviceCredentialsByIdRequest, GetDeviceCredentialsRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class DeviceCredentialsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a device credential.
|
|
11
|
+
* Delete a device credential
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteDeviceCredentialsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Device Credentials relate to refresh tokens and rotating refresh tokens for a given user_id.
|
|
18
|
+
*
|
|
19
|
+
* Note: Device Credentials APIs are designed for ad-hoc administrative use only, and paging is by default enabled for GET requests.
|
|
20
|
+
* Note: When Refresh Token Rotation is enabled, the endpoint becomes eventual consistent.
|
|
21
|
+
*
|
|
22
|
+
* Retrieve device credentials
|
|
23
|
+
*
|
|
24
|
+
* @throws {RequiredError}
|
|
25
|
+
*/
|
|
26
|
+
getAll(requestParameters: GetDeviceCredentialsRequest & {
|
|
27
|
+
include_totals: true;
|
|
28
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetDeviceCredentials200ResponseOneOf>>;
|
|
29
|
+
getAll(requestParameters?: GetDeviceCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<DeviceCredential>>>;
|
|
30
|
+
/**
|
|
31
|
+
* Device Credentials relate to refresh tokens and rotating refresh tokens for a given user_id.
|
|
32
|
+
*
|
|
33
|
+
* Note: Device Credentials APIs are designed for ad-hoc administrative use only, and paging is by default enabled for GET requests.
|
|
34
|
+
* Note: When Refresh Token Rotation is enabled, the endpoint becomes eventual consistent.
|
|
35
|
+
*
|
|
36
|
+
* Create a device public key credential
|
|
37
|
+
*
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
createPublicKey(bodyParameters: DeviceCredentialCreate, initOverrides?: InitOverride): Promise<ApiResponse<PostDeviceCredentials201Response>>;
|
|
41
|
+
}
|
|
42
|
+
export {};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { EmailTemplateUpdate, GetEmailTemplatesByTemplateName200Response, PostEmailTemplatesRequest, GetEmailTemplatesByTemplateNameRequest, PatchEmailTemplatesByTemplateNameRequest, PutEmailTemplatesByTemplateNameRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class EmailTemplatesManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* 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.
|
|
11
|
+
* Get an email template
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
get(requestParameters: GetEmailTemplatesByTemplateNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>;
|
|
16
|
+
/**
|
|
17
|
+
* Modify an email template.
|
|
18
|
+
* Patch an email template
|
|
19
|
+
*
|
|
20
|
+
* @throws {RequiredError}
|
|
21
|
+
*/
|
|
22
|
+
update(requestParameters: PatchEmailTemplatesByTemplateNameRequest, bodyParameters: GetEmailTemplatesByTemplateName200Response, initOverrides?: InitOverride): Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>;
|
|
23
|
+
/**
|
|
24
|
+
* Create an email template.
|
|
25
|
+
* Create an email template
|
|
26
|
+
*
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
create(bodyParameters: PostEmailTemplatesRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostEmailTemplatesRequest>>;
|
|
30
|
+
/**
|
|
31
|
+
* Update an email template.
|
|
32
|
+
* Update an email template
|
|
33
|
+
*
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
put(requestParameters: PutEmailTemplatesByTemplateNameRequest, bodyParameters: EmailTemplateUpdate, initOverrides?: InitOverride): Promise<ApiResponse<PostEmailTemplatesRequest>>;
|
|
37
|
+
}
|
|
38
|
+
export {};
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { EmailProvider, PatchProviderRequest, PostProviderRequest, GetProviderRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class EmailsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* 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.
|
|
11
|
+
*
|
|
12
|
+
* Get the email provider
|
|
13
|
+
*
|
|
14
|
+
* @throws {RequiredError}
|
|
15
|
+
*/
|
|
16
|
+
get(requestParameters?: GetProviderRequest, initOverrides?: InitOverride): Promise<ApiResponse<EmailProvider>>;
|
|
17
|
+
/**
|
|
18
|
+
* Update an <a href="https://auth0.com/docs/email/providers">email provider</a>.
|
|
19
|
+
* The <code>credentials</code> object requires different properties depending on the email provider (which is specified using the <code>name</code> property):
|
|
20
|
+
* <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:
|
|
21
|
+
* <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>
|
|
22
|
+
*
|
|
23
|
+
* Update the email provider
|
|
24
|
+
*
|
|
25
|
+
* @throws {RequiredError}
|
|
26
|
+
*/
|
|
27
|
+
update(bodyParameters: PatchProviderRequest, initOverrides?: InitOverride): Promise<ApiResponse<EmailProvider>>;
|
|
28
|
+
/**
|
|
29
|
+
* Create an <a href="https://auth0.com/docs/email/providers">email provider</a>.
|
|
30
|
+
* The <code>credentials</code> object requires different properties depending on the email provider (which is specified using the <code>name</code> property):
|
|
31
|
+
* <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:
|
|
32
|
+
* <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>
|
|
33
|
+
*
|
|
34
|
+
* Configure the email provider
|
|
35
|
+
*
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
configure(bodyParameters: PostProviderRequest, initOverrides?: InitOverride): Promise<ApiResponse<EmailProvider>>;
|
|
39
|
+
}
|
|
40
|
+
export {};
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { GetGrants200ResponseOneOf, UserGrant, DeleteRequest, DeleteGrantsByIdRequest, GetGrantsRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class GrantsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a grant associated with your account.
|
|
11
|
+
* Delete a grant by user_id
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
deleteByUserId(requestParameters?: DeleteRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Delete a grant associated with your account.
|
|
18
|
+
* Delete a grant by id
|
|
19
|
+
*
|
|
20
|
+
* @throws {RequiredError}
|
|
21
|
+
*/
|
|
22
|
+
delete(requestParameters: DeleteGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieve the <a href="https://auth0.com/docs/api-auth/which-oauth-flow-to-use">grants</a> associated with your account.
|
|
25
|
+
* Get grants
|
|
26
|
+
*
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
getAll(requestParameters: GetGrantsRequest & {
|
|
30
|
+
include_totals: true;
|
|
31
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetGrants200ResponseOneOf>>;
|
|
32
|
+
getAll(requestParameters?: GetGrantsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<UserGrant>>>;
|
|
33
|
+
}
|
|
34
|
+
export {};
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Enrollment, EnrollmentCreate, Factor, GetApns200Response, GetMessageTypes200Response, GetPhoneProviders200Response, GetPnProviders200Response, PostTicket200Response, PutApns200Response, PutApnsRequest, PutFactorsByName200Response, PutFactorsByNameRequest, PutFcmRequest, PutMessageTypesRequest, PutPhoneProvidersRequest, PutPnProvidersRequest, PutSnsRequest, PutTwilioRequest, SnsFactorProvider, TemplateMessages, TwilioFactorProvider, DeleteEnrollmentsByIdRequest, GetEnrollmentsByIdRequest, PutFactorsByNameOperationRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class GuardianManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete an enrollment to allow the user to enroll with multi-factor authentication again.
|
|
11
|
+
* Delete a multi-factor authentication enrollment
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
deleteGuardianEnrollment(requestParameters: DeleteEnrollmentsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve APNS push notification configuration
|
|
18
|
+
*
|
|
19
|
+
* @throws {RequiredError}
|
|
20
|
+
*/
|
|
21
|
+
getPushNotificationProviderAPNS(initOverrides?: InitOverride): Promise<ApiResponse<GetApns200Response>>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve an enrollment (including its status and type).
|
|
24
|
+
*
|
|
25
|
+
* Note: Phone numbers are partially obfuscated.
|
|
26
|
+
* Retrieve a multi-factor authentication enrollment
|
|
27
|
+
*
|
|
28
|
+
* @throws {RequiredError}
|
|
29
|
+
*/
|
|
30
|
+
getGuardianEnrollment(requestParameters: GetEnrollmentsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Enrollment>>;
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve phone enrollment and verification templates (subscription required).
|
|
33
|
+
* Retrieve Enrollment and Verification Phone Templates
|
|
34
|
+
*
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
getPhoneFactorTemplates(initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
|
|
38
|
+
/**
|
|
39
|
+
* Retrieve SMS enrollment and verification templates (subscription required).
|
|
40
|
+
*
|
|
41
|
+
* A new endpoint is available to retrieve enrollment and verification templates related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_templates'>phone templates</a>). It has the same payload as this one. Please use it instead.
|
|
42
|
+
* Retrieve SMS Enrollment and Verification Templates
|
|
43
|
+
*
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
getSmsFactorTemplates(initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
|
|
47
|
+
/**
|
|
48
|
+
* Retrieve all <a href="https://auth0.com/docs/multifactor-authentication">multi-factor authentication</a> configurations.
|
|
49
|
+
* Retrieve Factors and their Status
|
|
50
|
+
*
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
getFactors(initOverrides?: InitOverride): Promise<ApiResponse<Array<Factor>>>;
|
|
54
|
+
/**
|
|
55
|
+
* Retrieve the Enabled Phone Factors
|
|
56
|
+
*
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
getPhoneFactorMessageTypes(initOverrides?: InitOverride): Promise<ApiResponse<GetMessageTypes200Response>>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieve phone configuration (one of auth0|twilio|phone-message-hook)
|
|
62
|
+
*
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
getPhoneFactorSelectedProvider(initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
|
|
66
|
+
/**
|
|
67
|
+
* Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio phone provider configuration</a> (subscription required).
|
|
68
|
+
* Retrieve Twilio phone configuration
|
|
69
|
+
*
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
*/
|
|
72
|
+
getPhoneFactorProviderTwilio(initOverrides?: InitOverride): Promise<ApiResponse<TwilioFactorProvider>>;
|
|
73
|
+
/**
|
|
74
|
+
* Retrieve push notification provider
|
|
75
|
+
*
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
getPushNotificationSelectedProvider(initOverrides?: InitOverride): Promise<ApiResponse<GetPnProviders200Response>>;
|
|
79
|
+
/**
|
|
80
|
+
* Gets the MFA policies for the tenant.
|
|
81
|
+
*
|
|
82
|
+
* The following policies are supported: <ul><li><code>all-applications</code> policy - will prompt with MFA for all logins.</li><li><code>confidence-score</code> policy - will prompt with MFA only for low confidence logins.</li></ul>
|
|
83
|
+
* Use of the Adaptive MFA feature requires an add-on for the Enterprise plan. Please contact sales with any questions. For more information about Adaptive MFA, read our <a href="https://auth0.com/docs/mfa/adaptive-mfa">full documentation</a>.
|
|
84
|
+
*
|
|
85
|
+
* Get the Multi-factor Authentication policies
|
|
86
|
+
*
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
getPolicies(initOverrides?: InitOverride): Promise<ApiResponse<Array<string>>>;
|
|
90
|
+
/**
|
|
91
|
+
* A new endpoint is available to retrieve the configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider'>phone configuration</a>). It has the same payload as this one. Please use it instead.
|
|
92
|
+
* Retrieve SMS configuration (one of auth0|twilio|phone-message-hook)
|
|
93
|
+
*
|
|
94
|
+
* @throws {RequiredError}
|
|
95
|
+
*/
|
|
96
|
+
getSmsSelectedProvider(initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
|
|
97
|
+
/**
|
|
98
|
+
* Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio SMS provider configuration</a> (subscription required).
|
|
99
|
+
*
|
|
100
|
+
* A new endpoint is available to retrieve the Twilio configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/get_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.
|
|
101
|
+
* Retrieve Twilio SMS configuration
|
|
102
|
+
*
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
getSmsFactorProviderTwilio(initOverrides?: InitOverride): Promise<ApiResponse<TwilioFactorProvider>>;
|
|
106
|
+
/**
|
|
107
|
+
* Retrieve the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
|
|
108
|
+
* Retrieve AWS SNS push notification configuration
|
|
109
|
+
*
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
getPushNotificationProviderSNS(initOverrides?: InitOverride): Promise<ApiResponse<SnsFactorProvider>>;
|
|
113
|
+
/**
|
|
114
|
+
* Updates APNs provider configuration
|
|
115
|
+
*
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
updatePushNotificationProviderAPNS(bodyParameters: PutApnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutApns200Response>>;
|
|
119
|
+
/**
|
|
120
|
+
* Updates FCM provider configuration
|
|
121
|
+
*
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
updatePushNotificationProviderFCM(bodyParameters: PutFcmRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
|
|
125
|
+
[key: string]: any;
|
|
126
|
+
}>>;
|
|
127
|
+
/**
|
|
128
|
+
* Configure the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
|
|
129
|
+
* Update SNS configuration for push notifications
|
|
130
|
+
*
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
updatePushNotificationProviderSNS(bodyParameters: PutSnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutSnsRequest>>;
|
|
134
|
+
/**
|
|
135
|
+
* Generate an email with a link to start the multi-factor authentication enrollment process (subscription required).
|
|
136
|
+
* Create a multi-factor authentication enrollment ticket
|
|
137
|
+
*
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
*/
|
|
140
|
+
createEnrollmentTicket(bodyParameters: EnrollmentCreate, initOverrides?: InitOverride): Promise<ApiResponse<PostTicket200Response>>;
|
|
141
|
+
/**
|
|
142
|
+
* Updates APNs provider configuration
|
|
143
|
+
*
|
|
144
|
+
* @throws {RequiredError}
|
|
145
|
+
*/
|
|
146
|
+
setPushNotificationProviderAPNS(bodyParameters: PutApnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutApns200Response>>;
|
|
147
|
+
/**
|
|
148
|
+
* Customize the messages sent to complete phone enrollment and verification (subscription required).
|
|
149
|
+
* Update Enrollment and Verification Phone Templates
|
|
150
|
+
*
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
setPhoneFactorTemplates(bodyParameters: TemplateMessages, initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
|
|
154
|
+
/**
|
|
155
|
+
* Customize the messages sent to complete SMS enrollment and verification (subscription required).
|
|
156
|
+
*
|
|
157
|
+
* A new endpoint is available to update enrollment and verification templates related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/put_templates'>phone templates</a>). It has the same payload as this one. Please use it instead.
|
|
158
|
+
* Update SMS Enrollment and Verification Templates
|
|
159
|
+
*
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
setSmsFactorTemplates(bodyParameters: TemplateMessages, initOverrides?: InitOverride): Promise<ApiResponse<TemplateMessages>>;
|
|
163
|
+
/**
|
|
164
|
+
* Update a multi-factor authentication factor (subscription required).
|
|
165
|
+
* Update a Multi-factor Authentication Factor
|
|
166
|
+
*
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
updateFactor(requestParameters: PutFactorsByNameOperationRequest, bodyParameters: PutFactorsByNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutFactorsByName200Response>>;
|
|
170
|
+
/**
|
|
171
|
+
* Updates FCM provider configuration
|
|
172
|
+
*
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
*/
|
|
175
|
+
setPushNotificationProviderFCM(bodyParameters: PutFcmRequest, initOverrides?: InitOverride): Promise<ApiResponse<{
|
|
176
|
+
[key: string]: any;
|
|
177
|
+
}>>;
|
|
178
|
+
/**
|
|
179
|
+
* Update enabled phone factors for multi-factor authentication
|
|
180
|
+
* Update the Enabled Phone Factors
|
|
181
|
+
*
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
updatePhoneFactorMessageTypes(bodyParameters: PutMessageTypesRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetMessageTypes200Response>>;
|
|
185
|
+
/**
|
|
186
|
+
* Update phone configuration (one of auth0|twilio|phone-message-hook)
|
|
187
|
+
*
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
updatePhoneFactorSelectedProvider(bodyParameters: PutPhoneProvidersRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
|
|
191
|
+
/**
|
|
192
|
+
* Update Push Notification configuration (one of direct|sns|guardian)
|
|
193
|
+
*
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
setPushNotificationSelectedProvider(bodyParameters: PutPnProvidersRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetPnProviders200Response>>;
|
|
197
|
+
/**
|
|
198
|
+
* Sets the MFA policies for the tenant.
|
|
199
|
+
*
|
|
200
|
+
* The following policies are supported: <ul><li><code>all-applications</code> policy - will prompt with MFA for all logins.</li><li><code>confidence-score</code> policy - will prompt with MFA only for low confidence logins.</li></ul> Pass an empty array to remove all MFA policies.
|
|
201
|
+
* Use of the Adaptive MFA feature requires an add-on for the Enterprise plan. Please contact sales with any questions. For more information about Adaptive MFA, read our <a href="https://auth0.com/docs/mfa/adaptive-mfa">full documentation</a>.
|
|
202
|
+
*
|
|
203
|
+
*
|
|
204
|
+
* Set the Multi-factor Authentication policies
|
|
205
|
+
*
|
|
206
|
+
* @throws {RequiredError}
|
|
207
|
+
*/
|
|
208
|
+
updatePolicies(bodyParameters: Array<string>, initOverrides?: InitOverride): Promise<ApiResponse<Array<string>>>;
|
|
209
|
+
/**
|
|
210
|
+
* A new endpoint is available to update the configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider'>phone configuration</a>). It has the same payload as this one. Please use it instead.
|
|
211
|
+
* Update SMS configuration (one of auth0|twilio|phone-message-hook)
|
|
212
|
+
*
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
*/
|
|
215
|
+
setSmsSelectedProvider(bodyParameters: PutPhoneProvidersRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetPhoneProviders200Response>>;
|
|
216
|
+
/**
|
|
217
|
+
* Configure the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio SMS provider configuration</a> (subscription required).
|
|
218
|
+
*
|
|
219
|
+
* A new endpoint is available to update the Twilio configuration related to phone factors (<a href='https://manage.local.dev.auth0.com/docs/api/management/v2/#!/Guardian/put_twilio'>phone Twilio configuration</a>). It has the same payload as this one. Please use it instead.
|
|
220
|
+
* Update Twilio SMS configuration
|
|
221
|
+
*
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
*/
|
|
224
|
+
setSmsFactorProviderTwilio(bodyParameters: PutTwilioRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutTwilioRequest>>;
|
|
225
|
+
/**
|
|
226
|
+
* Configure the <a href="https://auth0.com/docs/multifactor-authentication/developer/sns-configuration">AWS SNS push notification provider configuration</a> (subscription required).
|
|
227
|
+
* Update AWS SNS push notification configuration
|
|
228
|
+
*
|
|
229
|
+
* @throws {RequiredError}
|
|
230
|
+
*/
|
|
231
|
+
setPushNotificationProviderSNS(bodyParameters: PutSnsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutSnsRequest>>;
|
|
232
|
+
/**
|
|
233
|
+
* Configure the <a href="https://auth0.com/docs/multifactor-authentication/twilio-configuration">Twilio phone provider configuration</a> (subscription required).
|
|
234
|
+
* Update Twilio phone configuration
|
|
235
|
+
*
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
updatePhoneFactorProviderTwilio(bodyParameters: PutTwilioRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutTwilioRequest>>;
|
|
239
|
+
}
|
|
240
|
+
export {};
|