auth0 4.0.0-beta.6 → 4.0.0-beta.7
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 +11 -8
- package/dist/{types → cjs}/auth/base-auth-api.d.ts +9 -2
- package/dist/cjs/auth/base-auth-api.js +32 -4
- package/dist/cjs/auth/base-auth-api.js.map +1 -1
- package/dist/{types → cjs}/auth/client-authentication.d.ts +1 -1
- package/dist/cjs/auth/client-authentication.js +2 -3
- package/dist/cjs/auth/client-authentication.js.map +1 -1
- package/dist/{types → cjs}/auth/database.d.ts +4 -0
- package/dist/cjs/auth/database.js.map +1 -1
- package/dist/{types → cjs}/auth/oauth.d.ts +2 -8
- package/dist/cjs/auth/oauth.js +8 -35
- package/dist/cjs/auth/oauth.js.map +1 -1
- package/dist/{types → cjs}/auth/passwordless.d.ts +1 -1
- package/dist/cjs/auth/passwordless.js +16 -8
- package/dist/cjs/auth/passwordless.js.map +1 -1
- package/dist/{types → cjs}/index.d.ts +1 -0
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/{types → cjs}/lib/retry.d.ts +1 -1
- package/dist/cjs/lib/retry.js +2 -4
- package/dist/cjs/lib/retry.js.map +1 -1
- package/dist/{types → cjs}/lib/runtime.d.ts +1 -10
- package/dist/cjs/lib/runtime.js +3 -23
- package/dist/cjs/lib/runtime.js.map +1 -1
- package/dist/cjs/management/__generated/managers/jobs-manager.js +1 -1
- package/dist/cjs/management/__generated/managers/jobs-manager.js.map +1 -1
- package/dist/{types → cjs}/management/__generated/models/index.d.ts +1 -3
- package/dist/cjs/management/__generated/models/index.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +1 -1
- package/dist/esm/auth/base-auth-api.d.ts +39 -0
- package/dist/esm/auth/base-auth-api.js +31 -4
- package/dist/esm/auth/base-auth-api.js.map +1 -1
- package/dist/esm/auth/client-authentication.d.ts +26 -0
- package/dist/esm/auth/client-authentication.js +2 -3
- package/dist/esm/auth/client-authentication.js.map +1 -1
- package/dist/esm/auth/database.d.ts +157 -0
- package/dist/esm/auth/database.js.map +1 -1
- package/dist/esm/auth/id-token-validator.d.ts +18 -0
- package/dist/esm/auth/index.d.ts +15 -0
- package/dist/esm/auth/oauth.d.ts +297 -0
- package/dist/esm/auth/oauth.js +10 -37
- package/dist/esm/auth/oauth.js.map +1 -1
- package/dist/esm/auth/passwordless.d.ts +165 -0
- package/dist/esm/auth/passwordless.js +17 -9
- package/dist/esm/auth/passwordless.js.map +1 -1
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/lib/errors.d.ts +33 -0
- package/dist/esm/lib/index.d.ts +3 -0
- package/dist/esm/lib/middleware/telemetry-middleware.d.ts +12 -0
- package/dist/esm/lib/models.d.ts +123 -0
- package/dist/esm/lib/retry.d.ts +26 -0
- package/dist/esm/lib/retry.js +2 -4
- package/dist/esm/lib/retry.js.map +1 -1
- package/dist/esm/lib/runtime.d.ts +61 -0
- package/dist/esm/lib/runtime.js +2 -21
- package/dist/esm/lib/runtime.js.map +1 -1
- package/dist/esm/management/__generated/index.d.ts +39 -0
- package/dist/esm/management/__generated/managers/actions-manager.d.ts +136 -0
- package/dist/esm/management/__generated/managers/anomaly-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/attack-protection-manager.d.ts +58 -0
- package/dist/esm/management/__generated/managers/blacklists-manager.d.ts +28 -0
- package/dist/esm/management/__generated/managers/branding-manager.d.ts +103 -0
- package/dist/esm/management/__generated/managers/client-grants-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/clients-manager.d.ts +168 -0
- package/dist/esm/management/__generated/managers/connections-manager.d.ts +87 -0
- package/dist/esm/management/__generated/managers/custom-domains-manager.d.ts +106 -0
- package/dist/esm/management/__generated/managers/device-credentials-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/email-templates-manager.d.ts +38 -0
- package/dist/esm/management/__generated/managers/emails-manager.d.ts +40 -0
- package/dist/esm/management/__generated/managers/grants-manager.d.ts +34 -0
- package/dist/esm/management/__generated/managers/guardian-manager.d.ts +240 -0
- package/dist/esm/management/__generated/managers/hooks-manager.d.ts +90 -0
- package/dist/esm/management/__generated/managers/index.d.ts +31 -0
- package/dist/esm/management/__generated/managers/jobs-manager.d.ts +47 -0
- package/dist/esm/management/__generated/managers/jobs-manager.js +1 -1
- package/dist/esm/management/__generated/managers/jobs-manager.js.map +1 -1
- package/dist/esm/management/__generated/managers/keys-manager.d.ts +34 -0
- package/dist/esm/management/__generated/managers/log-streams-manager.d.ts +326 -0
- package/dist/esm/management/__generated/managers/logs-manager.d.ts +56 -0
- package/dist/esm/management/__generated/managers/organizations-manager.d.ts +191 -0
- package/dist/esm/management/__generated/managers/prompts-manager.d.ts +42 -0
- package/dist/esm/management/__generated/managers/resource-servers-manager.d.ts +48 -0
- package/dist/esm/management/__generated/managers/roles-manager.d.ts +110 -0
- package/dist/esm/management/__generated/managers/rules-configs-manager.d.ts +33 -0
- package/dist/esm/management/__generated/managers/rules-manager.d.ts +55 -0
- package/dist/esm/management/__generated/managers/stats-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/tenants-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/tickets-manager.d.ts +24 -0
- package/dist/esm/management/__generated/managers/user-blocks-manager.d.ts +45 -0
- package/dist/esm/management/__generated/managers/users-by-email-manager.d.ts +22 -0
- package/dist/esm/management/__generated/managers/users-manager.d.ts +329 -0
- package/dist/esm/management/__generated/models/index.d.ts +13201 -0
- package/dist/esm/management/__generated/models/index.js.map +1 -1
- package/dist/esm/management/index.d.ts +3 -0
- package/dist/esm/management/management-client-options.d.ts +17 -0
- package/dist/esm/management/management-client.d.ts +16 -0
- package/dist/esm/management/token-provider-middleware.d.ts +7 -0
- package/dist/esm/management/token-provider.d.ts +21 -0
- package/dist/esm/userinfo/index.d.ts +55 -0
- package/dist/esm/utils.d.ts +10 -0
- package/dist/esm/version.d.ts +1 -0
- package/dist/esm/version.js +1 -1
- package/package.json +16 -20
- package/dist/types/version.d.ts +0 -1
- /package/dist/{types → cjs}/auth/id-token-validator.d.ts +0 -0
- /package/dist/{types → cjs}/auth/index.d.ts +0 -0
- /package/dist/{types → cjs}/lib/errors.d.ts +0 -0
- /package/dist/{types → cjs}/lib/index.d.ts +0 -0
- /package/dist/{types → cjs}/lib/middleware/telemetry-middleware.d.ts +0 -0
- /package/dist/{types → cjs}/lib/models.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/index.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/actions-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/anomaly-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/attack-protection-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/blacklists-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/branding-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/client-grants-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/clients-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/connections-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/custom-domains-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/device-credentials-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/email-templates-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/emails-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/grants-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/guardian-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/hooks-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/index.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/jobs-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/keys-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/log-streams-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/logs-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/organizations-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/prompts-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/resource-servers-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/roles-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/rules-configs-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/rules-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/stats-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/tenants-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/tickets-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/user-blocks-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/users-by-email-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/__generated/managers/users-manager.d.ts +0 -0
- /package/dist/{types → cjs}/management/index.d.ts +0 -0
- /package/dist/{types → cjs}/management/management-client-options.d.ts +0 -0
- /package/dist/{types → cjs}/management/management-client.d.ts +0 -0
- /package/dist/{types → cjs}/management/token-provider-middleware.d.ts +0 -0
- /package/dist/{types → cjs}/management/token-provider.d.ts +0 -0
- /package/dist/{types → cjs}/userinfo/index.d.ts +0 -0
- /package/dist/{types → cjs}/utils.d.ts +0 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Token, GetTokensRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class BlacklistsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve the `jti` and `aud` of all tokens that are blacklisted.
|
|
11
|
+
*
|
|
12
|
+
* Note: The <a href="https://auth0.com/docs/jwt">JWT specification</a> states that the `jti` field can be used to prevent replay attacks. Though Auth0 tokens do not include a `jti`, you can nevertheless blacklist a `jti` to prevent a token being used more than a predetermined number of times. This behavior is similar to implementing a nonce (where the token's signature can be thought of as the nonce). If a token gets stolen, it (or the tokens issued after it) should be blacklisted and let expire.
|
|
13
|
+
*
|
|
14
|
+
* Get blacklisted tokens
|
|
15
|
+
*
|
|
16
|
+
* @throws {RequiredError}
|
|
17
|
+
*/
|
|
18
|
+
getAll(requestParameters?: GetTokensRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Token>>>;
|
|
19
|
+
/**
|
|
20
|
+
* Add the token identified by the `jti` to a blacklist for the tenant.
|
|
21
|
+
*
|
|
22
|
+
* Blacklist a token
|
|
23
|
+
*
|
|
24
|
+
* @throws {RequiredError}
|
|
25
|
+
*/
|
|
26
|
+
add(bodyParameters: Token, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
27
|
+
}
|
|
28
|
+
export {};
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { GetBranding200Response, GetUniversalLogin200Response, PatchBrandingRequest, PostBrandingTheme200Response, PostBrandingThemeRequest, PutUniversalLoginRequest, DeleteBrandingThemeRequest, GetBrandingThemeRequest, PatchBrandingThemeRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class BrandingManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete branding theme.
|
|
11
|
+
* Delete branding theme
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
deleteTheme(requestParameters: DeleteBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Delete template for New Universal Login Experience
|
|
18
|
+
*
|
|
19
|
+
* @throws {RequiredError}
|
|
20
|
+
*/
|
|
21
|
+
deleteUniversalLoginTemplate(initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve branding settings.
|
|
24
|
+
* Get branding settings
|
|
25
|
+
*
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
getSettings(initOverrides?: InitOverride): Promise<ApiResponse<GetBranding200Response>>;
|
|
29
|
+
/**
|
|
30
|
+
* Retrieve branding theme.
|
|
31
|
+
* Get branding theme
|
|
32
|
+
*
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
getTheme(requestParameters: GetBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
36
|
+
/**
|
|
37
|
+
* Retrieve default branding theme.
|
|
38
|
+
* Get default branding theme
|
|
39
|
+
*
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
getDefaultTheme(initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
43
|
+
/**
|
|
44
|
+
* Get template for New Universal Login Experience
|
|
45
|
+
*
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getUniversalLoginTemplate(initOverrides?: InitOverride): Promise<ApiResponse<GetUniversalLogin200Response>>;
|
|
49
|
+
/**
|
|
50
|
+
* Update branding settings.
|
|
51
|
+
* Update branding settings
|
|
52
|
+
*
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
updateSettings(bodyParameters: PatchBrandingRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetBranding200Response>>;
|
|
56
|
+
/**
|
|
57
|
+
* Update branding theme.
|
|
58
|
+
* Update branding theme
|
|
59
|
+
*
|
|
60
|
+
* @throws {RequiredError}
|
|
61
|
+
*/
|
|
62
|
+
updateTheme(requestParameters: PatchBrandingThemeRequest, bodyParameters: PostBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
63
|
+
/**
|
|
64
|
+
* Create branding theme.
|
|
65
|
+
* Create branding theme
|
|
66
|
+
*
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
createTheme(bodyParameters: PostBrandingThemeRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostBrandingTheme200Response>>;
|
|
70
|
+
/**
|
|
71
|
+
* Update the Universal Login branding template.
|
|
72
|
+
*
|
|
73
|
+
* <p>When <code>content-type</code> header is set to <code>application/json</code>, the expected body must be JSON:</p>
|
|
74
|
+
* <pre>
|
|
75
|
+
* {
|
|
76
|
+
* "template": "<!DOCTYPE html><html><head>{%- auth0:head -%}</head><body>{%- auth0:widget -%}</body></html>"
|
|
77
|
+
* }
|
|
78
|
+
* </pre>
|
|
79
|
+
*
|
|
80
|
+
* <p>
|
|
81
|
+
* When <code>content-type</code> header is set to <code>text/html</code>, the expected body must be the HTML template:
|
|
82
|
+
* </p>
|
|
83
|
+
* <pre>
|
|
84
|
+
* <!DOCTYPE html>
|
|
85
|
+
* <code>
|
|
86
|
+
* <html>
|
|
87
|
+
* <head>
|
|
88
|
+
* {%- auth0:head -%}
|
|
89
|
+
* </head>
|
|
90
|
+
* <body>
|
|
91
|
+
* {%- auth0:widget -%}
|
|
92
|
+
* </body>
|
|
93
|
+
* </html>
|
|
94
|
+
* </code>
|
|
95
|
+
* </pre>
|
|
96
|
+
*
|
|
97
|
+
* Set template for New Universal Login Experience
|
|
98
|
+
*
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
setUniversalLoginTemplate(bodyParameters: PutUniversalLoginRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
102
|
+
}
|
|
103
|
+
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 { ClientGrant, ClientGrantCreate, PatchClientGrantsByIdRequest, GetClientGrants200ResponseOneOf, DeleteClientGrantsByIdRequest, GetClientGrantsRequest, PatchClientGrantsByIdOperationRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ClientGrantsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a client grant.
|
|
11
|
+
* Delete client grant
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteClientGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Retrieve <a href="https://auth0.com/docs/api-auth/grant/client-credentials">client grants</a>.
|
|
18
|
+
*
|
|
19
|
+
* Get client grants
|
|
20
|
+
*
|
|
21
|
+
* @throws {RequiredError}
|
|
22
|
+
*/
|
|
23
|
+
getAll(requestParameters: GetClientGrantsRequest & {
|
|
24
|
+
include_totals: true;
|
|
25
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetClientGrants200ResponseOneOf>>;
|
|
26
|
+
getAll(requestParameters?: GetClientGrantsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<ClientGrant>>>;
|
|
27
|
+
/**
|
|
28
|
+
* Update a client grant.
|
|
29
|
+
* Update client grant
|
|
30
|
+
*
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
update(requestParameters: PatchClientGrantsByIdOperationRequest, bodyParameters: PatchClientGrantsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<ClientGrant>>;
|
|
34
|
+
/**
|
|
35
|
+
* Create a client grant.
|
|
36
|
+
* Create client grant
|
|
37
|
+
*
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
create(bodyParameters: ClientGrantCreate, initOverrides?: InitOverride): Promise<ApiResponse<ClientGrant>>;
|
|
41
|
+
}
|
|
42
|
+
export {};
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Client, ClientCreate, ClientUpdate, GetCredentials200ResponseInner, PatchCredentialsByCredentialIdRequest, PostCredentialsRequest, DeleteClientsByIdRequest, DeleteCredentialsByCredentialIdRequest, GetClientsRequest, GetClientsByIdRequest, GetCredentialsRequest, GetCredentialsByCredentialIdRequest, PatchClientsByIdRequest, PatchCredentialsByCredentialIdOperationRequest, PostCredentialsOperationRequest, PostRotateSecretRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ClientsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Delete a client and related configuration (rules, connections, etc).
|
|
11
|
+
* Delete a client
|
|
12
|
+
*
|
|
13
|
+
* @throws {RequiredError}
|
|
14
|
+
*/
|
|
15
|
+
delete(requestParameters: DeleteClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
16
|
+
/**
|
|
17
|
+
* Delete a client credential
|
|
18
|
+
*
|
|
19
|
+
* @throws {RequiredError}
|
|
20
|
+
*/
|
|
21
|
+
deleteCredential(requestParameters: DeleteCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve clients (applications and SSO integrations) matching provided filters. A list of fields to include or exclude
|
|
24
|
+
* may also be specified. Note:
|
|
25
|
+
* <ul>
|
|
26
|
+
* <li><code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
27
|
+
* any scope.
|
|
28
|
+
* </li>
|
|
29
|
+
* <li><code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
30
|
+
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
31
|
+
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
32
|
+
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
33
|
+
* <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
|
|
34
|
+
* <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
|
|
35
|
+
* <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
|
|
36
|
+
* <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
|
|
37
|
+
* <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
|
|
38
|
+
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
39
|
+
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
40
|
+
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
41
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
42
|
+
* <code>organization_require_behavior</code>
|
|
43
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
44
|
+
* <code>read:client_keys</code> scope.
|
|
45
|
+
* </li>
|
|
46
|
+
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
47
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
48
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
49
|
+
* </li>
|
|
50
|
+
* </ul>
|
|
51
|
+
*
|
|
52
|
+
* Get clients
|
|
53
|
+
*
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
getAll(requestParameters?: GetClientsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Client>>>;
|
|
57
|
+
/**
|
|
58
|
+
* Retrieve client details. A list of fields to include or exclude may also be specified. Note:
|
|
59
|
+
* <ul>
|
|
60
|
+
* <li><code>client_id</code>, <code>app_type</code>, <code>name</code>, and <code>description</code> can be retrieved with
|
|
61
|
+
* the any of the scopes.
|
|
62
|
+
* </li>
|
|
63
|
+
* <li><code>callbacks</code>, <code>oidc_backchannel_logout</code>, <code>allowed_origins</code>,
|
|
64
|
+
* <code>web_origins</code>, <code>tenant</code>, <code>global</code>, <code>config_route</code>,
|
|
65
|
+
* <code>callback_url_template</code>, <code>jwt_configuration</code>,
|
|
66
|
+
* <code>jwt_configuration.lifetime_in_seconds</code>, <code>jwt_configuration.secret_encoded</code>,
|
|
67
|
+
* <code>jwt_configuration.scopes</code>, <code>jwt_configuration.alg</code>, <code>api_type</code>,
|
|
68
|
+
* <code>logo_uri</code>, <code>allowed_clients</code>, <code>owners</code>, <code>custom_login_page</code>,
|
|
69
|
+
* <code>custom_login_page_off</code>, <code>sso</code>, <code>addons</code>, <code>form_template</code>,
|
|
70
|
+
* <code>custom_login_page_codeview</code>, <code>resource_servers</code>, <code>client_metadata</code>,
|
|
71
|
+
* <code>mobile</code>, <code>mobile.android</code>, <code>mobile.ios</code>, <code>allowed_logout_urls</code>,
|
|
72
|
+
* <code>token_endpoint_auth_method</code>, <code>is_first_party</code>, <code>oidc_conformant</code>,
|
|
73
|
+
* <code>is_token_endpoint_ip_header_trusted</code>, <code>initiate_login_uri</code>, <code>grant_types</code>,
|
|
74
|
+
* <code>refresh_token</code>, <code>refresh_token.rotation_type</code>, <code>refresh_token.expiration_type</code>,
|
|
75
|
+
* <code>refresh_token.leeway</code>, <code>refresh_token.token_lifetime</code>, <code>organization_usage</code>,
|
|
76
|
+
* <code>organization_require_behavior</code>
|
|
77
|
+
* properties can only be retrieved with the <code>read:clients</code> or
|
|
78
|
+
* <code>read:client_keys</code> scope.
|
|
79
|
+
* </li>
|
|
80
|
+
* <li><code>encryption_key</code>, <code>encryption_key.pub</code>, <code>encryption_key.cert</code>,
|
|
81
|
+
* <code>client_secret</code>, <code>client_authentication_methods</code> and <code>signing_key</code> properties can only be retrieved with the
|
|
82
|
+
* <code>read:client_keys</code> or <code>read:client_credentials</code> scope.
|
|
83
|
+
* </li>
|
|
84
|
+
* </ul>
|
|
85
|
+
*
|
|
86
|
+
* Get a client
|
|
87
|
+
*
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
get(requestParameters: GetClientsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
91
|
+
/**
|
|
92
|
+
* Get the list of client credentials that are associated to the client.
|
|
93
|
+
*
|
|
94
|
+
* Important: To enable credentials to be used for Private Key JWT authentication method, set the <code>client_authentication_methods</code> property on the client.
|
|
95
|
+
* Get client credentials
|
|
96
|
+
*
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
getCredentials(requestParameters: GetCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetCredentials200ResponseInner>>>;
|
|
100
|
+
/**
|
|
101
|
+
* Get the details of a client credential.
|
|
102
|
+
* Get client credential
|
|
103
|
+
*
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
getCredential(requestParameters: GetCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
|
|
107
|
+
/**
|
|
108
|
+
* Notes:
|
|
109
|
+
* - The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.
|
|
110
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
111
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
112
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
113
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, only specify the credential IDs
|
|
114
|
+
* that were generated when creating the credentials on the client.
|
|
115
|
+
* - To configure <code>client_authentication_methods</code>, the <code>update:client_credentials</code> scope is required.
|
|
116
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
117
|
+
* Update a client
|
|
118
|
+
*
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
update(requestParameters: PatchClientsByIdRequest, bodyParameters: ClientUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
122
|
+
/**
|
|
123
|
+
* Update a client credential
|
|
124
|
+
*
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
updateCredential(requestParameters: PatchCredentialsByCredentialIdOperationRequest, bodyParameters: PatchCredentialsByCredentialIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
|
|
128
|
+
/**
|
|
129
|
+
* Create a new client (application or SSO integration).
|
|
130
|
+
*
|
|
131
|
+
* Notes:
|
|
132
|
+
* - We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.
|
|
133
|
+
* - The <code>client_authentication_methods</code> and <code>token_endpoint_auth_method</code> properties are mutually exclusive. Use
|
|
134
|
+
* <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method. Otherwise, use <code>token_endpoint_auth_method</code>
|
|
135
|
+
* to configure the client with client secret (basic or post) or with no authentication method (none).
|
|
136
|
+
* - When using <code>client_authentication_methods</code> to configure the client with Private Key JWT authentication method, specify fully defined credentials.
|
|
137
|
+
* These credentials will be automatically enabled for Private Key JWT authentication on the client.
|
|
138
|
+
* - To configure <code>client_authentication_methods</code>, the <code>create:client_credentials</code> scope is required.
|
|
139
|
+
* - To configure <code>client_authentication_methods</code>, the property <code>jwt_configuration.alg</code> must be set to RS256.
|
|
140
|
+
*
|
|
141
|
+
* <div class="alert alert-warning">SSO Integrations created via this endpoint will accept login requests and share user profile information.</div>
|
|
142
|
+
*
|
|
143
|
+
* Create a client
|
|
144
|
+
*
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
create(bodyParameters: ClientCreate, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
148
|
+
/**
|
|
149
|
+
* Create a client credential associated to the client. The credential will be created but not yet enabled for use with Private Key JWT authentication method. To enable the credential, set the <code>client_authentication_methods</code> property on the client.
|
|
150
|
+
* Create a client credential
|
|
151
|
+
*
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
*/
|
|
154
|
+
createCredential(requestParameters: PostCredentialsOperationRequest, bodyParameters: PostCredentialsRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetCredentials200ResponseInner>>;
|
|
155
|
+
/**
|
|
156
|
+
* Rotate a client secret.
|
|
157
|
+
*
|
|
158
|
+
* This endpoint cannot be used with clients configured with Private Key JWT authentication method (client_authentication_methods configured with private_key_jwt).
|
|
159
|
+
*
|
|
160
|
+
* Note: The generated secret is NOT base64 encoded.
|
|
161
|
+
*
|
|
162
|
+
* Rotate a client secret
|
|
163
|
+
*
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
rotateClientSecret(requestParameters: PostRotateSecretRequest, initOverrides?: InitOverride): Promise<ApiResponse<Client>>;
|
|
167
|
+
}
|
|
168
|
+
export {};
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import * as runtime from '../../../lib/runtime.js';
|
|
2
|
+
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
|
|
3
|
+
import type { Connection, ConnectionCreate, ConnectionUpdate, GetConnections200ResponseOneOf, DeleteConnectionsByIdRequest, DeleteUsersByEmailRequest, GetConnectionsRequest, GetConnectionsByIdRequest, GetStatusRequest, PatchConnectionsByIdRequest } from '../models/index.js';
|
|
4
|
+
declare const BaseAPI: typeof runtime.BaseAPI;
|
|
5
|
+
/**
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export declare class ConnectionsManager extends BaseAPI {
|
|
9
|
+
/**
|
|
10
|
+
* Deletes a connection and all its users.
|
|
11
|
+
*
|
|
12
|
+
* Delete a connection
|
|
13
|
+
*
|
|
14
|
+
* @throws {RequiredError}
|
|
15
|
+
*/
|
|
16
|
+
delete(requestParameters: DeleteConnectionsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
17
|
+
/**
|
|
18
|
+
* Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.
|
|
19
|
+
*
|
|
20
|
+
* Delete a connection user
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
*/
|
|
24
|
+
deleteUserByEmail(requestParameters: DeleteUsersByEmailRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
25
|
+
/**
|
|
26
|
+
* Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
|
|
27
|
+
* This endpoint supports two types of pagination:
|
|
28
|
+
* - Offset pagination
|
|
29
|
+
* - Checkpoint pagination
|
|
30
|
+
*
|
|
31
|
+
* Checkpoint pagination should be used if you need to retrieve more than 1000 connections.
|
|
32
|
+
*
|
|
33
|
+
* <h2>Checkpoint Pagination</h2>
|
|
34
|
+
*
|
|
35
|
+
* To search by checkpoint, use the following parameters:
|
|
36
|
+
* - from: Optional id from which to start selection.
|
|
37
|
+
* - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
|
|
38
|
+
*
|
|
39
|
+
* The first time you call this endpoint using Checkpoint Pagination, you should omit the <code>from</code> parameter.
|
|
40
|
+
* If there are more results, a <code>next</code> value will be included in the response. You can use this for subsequent API calls.
|
|
41
|
+
* When <code>next</code> is no longer included in the response, this indicates there are no more pages remaining.
|
|
42
|
+
*
|
|
43
|
+
* Note: The <code>include_totals</code> parameter is not supported when using checkpoint pagination.
|
|
44
|
+
* Get all connections
|
|
45
|
+
*
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getAll(requestParameters: GetConnectionsRequest & {
|
|
49
|
+
include_totals: true;
|
|
50
|
+
}, initOverrides?: InitOverride): Promise<ApiResponse<GetConnections200ResponseOneOf>>;
|
|
51
|
+
getAll(requestParameters?: GetConnectionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Connection>>>;
|
|
52
|
+
/**
|
|
53
|
+
* Retrieves a connection by its <code>ID</code>.
|
|
54
|
+
*
|
|
55
|
+
* Get a connection
|
|
56
|
+
*
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
get(requestParameters: GetConnectionsByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieves the status of an ad/ldap connection referenced by its <code>ID</code>. <code>200 OK</code> http status code response is returned when the connection is online, otherwise a <code>404</code> status code is returned along with an error message
|
|
62
|
+
* Check connection status
|
|
63
|
+
*
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
checkStatus(requestParameters: GetStatusRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
|
|
67
|
+
/**
|
|
68
|
+
* <b>Note:</b> if you use the options parameter, the whole options object will be overridden, so ensure that all parameters are present
|
|
69
|
+
*
|
|
70
|
+
* Update a connection
|
|
71
|
+
*
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
update(requestParameters: PatchConnectionsByIdRequest, bodyParameters: ConnectionUpdate, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
75
|
+
/**
|
|
76
|
+
* Creates a new connection according to the JSON object received in <code>body</code>.
|
|
77
|
+
* The samples on the right show all available attributes. Mandatory attributes are <code>name</code> and <code>strategy</code>.
|
|
78
|
+
* 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>
|
|
79
|
+
*
|
|
80
|
+
* <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>
|
|
81
|
+
* Create a connection
|
|
82
|
+
*
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
create(bodyParameters: ConnectionCreate, initOverrides?: InitOverride): Promise<ApiResponse<Connection>>;
|
|
86
|
+
}
|
|
87
|
+
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 {};
|