auth0 5.5.0 → 5.6.0
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/dist/cjs/management/Client.d.ts +12 -0
- package/dist/cjs/management/Client.js +67 -0
- package/dist/cjs/management/api/requests/requests.d.ts +140 -22
- package/dist/cjs/management/api/resources/actions/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/actions/client/Client.js +3 -3
- package/dist/cjs/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.d.ts +2 -2
- package/dist/cjs/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.js +2 -2
- package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +0 -1
- package/dist/cjs/management/api/resources/clientGrants/client/Client.js +0 -1
- package/dist/cjs/management/api/resources/clients/client/Client.d.ts +46 -0
- package/dist/cjs/management/api/resources/clients/client/Client.js +146 -1
- package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +30 -0
- package/dist/cjs/management/api/resources/customDomains/client/Client.js +115 -0
- package/dist/cjs/management/api/resources/groups/client/Client.d.ts +16 -0
- package/dist/cjs/management/api/resources/groups/client/Client.js +57 -0
- package/dist/cjs/management/api/resources/networkAcls/client/Client.d.ts +0 -2
- package/dist/cjs/management/api/resources/networkAcls/client/Client.js +0 -2
- package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +3 -0
- package/dist/cjs/management/api/resources/organizations/client/Client.js +13 -8
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +95 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +383 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/client/index.js +2 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/connections/index.js +17 -0
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.ts +3 -1
- package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +3 -1
- package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +1 -0
- package/dist/cjs/management/api/resources/organizations/resources/index.js +2 -1
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +23 -0
- package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +88 -0
- package/dist/cjs/management/api/types/types.d.ts +492 -292
- package/dist/cjs/management/api/types/types.js +96 -103
- package/dist/cjs/management/core/auth/BasicAuth.d.ts +2 -2
- package/dist/cjs/management/core/auth/BasicAuth.js +7 -1
- package/dist/cjs/management/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/cjs/management/core/fetcher/Fetcher.d.ts +2 -0
- package/dist/cjs/management/core/fetcher/Fetcher.js +5 -1
- package/dist/cjs/management/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/management/core/fetcher/index.js +3 -1
- package/dist/cjs/management/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/cjs/management/core/fetcher/makePassthroughRequest.js +135 -0
- package/dist/cjs/management/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/cjs/management/core/fetcher/makeRequest.js +30 -9
- package/dist/cjs/management/core/pagination/Page.d.ts +1 -1
- package/dist/cjs/management/core/pagination/index.d.ts +0 -1
- package/dist/cjs/management/core/pagination/index.js +1 -4
- package/dist/cjs/management/core/runtime/runtime.js +8 -7
- package/dist/cjs/management/errors/ManagementError.d.ts +3 -1
- package/dist/cjs/management/errors/ManagementError.js +4 -1
- package/dist/cjs/management/errors/ManagementTimeoutError.d.ts +4 -1
- package/dist/cjs/management/errors/ManagementTimeoutError.js +4 -1
- package/dist/cjs/management/errors/handleNonStatusCodeError.js +4 -1
- package/dist/cjs/management/version.d.ts +1 -1
- package/dist/cjs/management/version.js +1 -1
- package/dist/esm/management/Client.d.mts +12 -0
- package/dist/esm/management/Client.mjs +34 -0
- package/dist/esm/management/api/requests/requests.d.mts +140 -22
- package/dist/esm/management/api/resources/actions/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/actions/client/Client.mjs +3 -3
- package/dist/esm/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.d.mts +2 -2
- package/dist/esm/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.mjs +2 -2
- package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +0 -1
- package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +0 -1
- package/dist/esm/management/api/resources/clients/client/Client.d.mts +46 -0
- package/dist/esm/management/api/resources/clients/client/Client.mjs +146 -1
- package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +30 -0
- package/dist/esm/management/api/resources/customDomains/client/Client.mjs +115 -0
- package/dist/esm/management/api/resources/groups/client/Client.d.mts +16 -0
- package/dist/esm/management/api/resources/groups/client/Client.mjs +57 -0
- package/dist/esm/management/api/resources/networkAcls/client/Client.d.mts +0 -2
- package/dist/esm/management/api/resources/networkAcls/client/Client.mjs +0 -2
- package/dist/esm/management/api/resources/organizations/client/Client.d.mts +3 -0
- package/dist/esm/management/api/resources/organizations/client/Client.mjs +5 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +95 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +346 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/client/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/connections/index.mjs +1 -0
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.mts +3 -1
- package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +3 -1
- package/dist/esm/management/api/resources/organizations/resources/index.d.mts +1 -0
- package/dist/esm/management/api/resources/organizations/resources/index.mjs +1 -0
- package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +23 -0
- package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +88 -0
- package/dist/esm/management/api/types/types.d.mts +492 -292
- package/dist/esm/management/api/types/types.mjs +86 -93
- package/dist/esm/management/core/auth/BasicAuth.d.mts +2 -2
- package/dist/esm/management/core/auth/BasicAuth.mjs +7 -1
- package/dist/esm/management/core/fetcher/BinaryResponse.d.mts +1 -1
- package/dist/esm/management/core/fetcher/Fetcher.d.mts +2 -0
- package/dist/esm/management/core/fetcher/Fetcher.mjs +5 -1
- package/dist/esm/management/core/fetcher/index.d.mts +2 -0
- package/dist/esm/management/core/fetcher/index.mjs +1 -0
- package/dist/esm/management/core/fetcher/makePassthroughRequest.d.mts +49 -0
- package/dist/esm/management/core/fetcher/makePassthroughRequest.mjs +132 -0
- package/dist/esm/management/core/fetcher/makeRequest.d.mts +6 -1
- package/dist/esm/management/core/fetcher/makeRequest.mjs +28 -9
- package/dist/esm/management/core/pagination/Page.d.mts +1 -1
- package/dist/esm/management/core/pagination/index.d.mts +0 -1
- package/dist/esm/management/core/pagination/index.mjs +0 -1
- package/dist/esm/management/core/runtime/runtime.mjs +8 -7
- package/dist/esm/management/errors/ManagementError.d.mts +3 -1
- package/dist/esm/management/errors/ManagementError.mjs +4 -1
- package/dist/esm/management/errors/ManagementTimeoutError.d.mts +4 -1
- package/dist/esm/management/errors/ManagementTimeoutError.mjs +4 -1
- package/dist/esm/management/errors/handleNonStatusCodeError.mjs +4 -1
- package/dist/esm/management/version.d.mts +1 -1
- package/dist/esm/management/version.mjs +1 -1
- package/package.json +5 -6
- package/reference.md +752 -30
- package/dist/cjs/management/core/pagination/CustomPager.d.ts +0 -67
- package/dist/cjs/management/core/pagination/CustomPager.js +0 -194
- package/dist/esm/management/core/pagination/CustomPager.d.mts +0 -67
- package/dist/esm/management/core/pagination/CustomPager.mjs +0 -189
|
@@ -3,7 +3,7 @@ import * as Management from "../index.mjs";
|
|
|
3
3
|
/**
|
|
4
4
|
* @example
|
|
5
5
|
* {
|
|
6
|
-
* triggerId: "
|
|
6
|
+
* triggerId: "post-login",
|
|
7
7
|
* actionName: "actionName",
|
|
8
8
|
* deployed: true,
|
|
9
9
|
* page: 1,
|
|
@@ -30,7 +30,7 @@ export interface ListActionsRequestParameters {
|
|
|
30
30
|
* {
|
|
31
31
|
* name: "name",
|
|
32
32
|
* supported_triggers: [{
|
|
33
|
-
* id: "
|
|
33
|
+
* id: "post-login"
|
|
34
34
|
* }]
|
|
35
35
|
* }
|
|
36
36
|
*/
|
|
@@ -133,13 +133,12 @@ export interface ListClientGrantsRequestParameters {
|
|
|
133
133
|
/**
|
|
134
134
|
* @example
|
|
135
135
|
* {
|
|
136
|
-
* client_id: "client_id",
|
|
137
136
|
* audience: "audience"
|
|
138
137
|
* }
|
|
139
138
|
*/
|
|
140
139
|
export interface CreateClientGrantRequestContent {
|
|
141
140
|
/** ID of the client. */
|
|
142
|
-
client_id
|
|
141
|
+
client_id?: string;
|
|
143
142
|
/** The audience (API identifier) of this client grant */
|
|
144
143
|
audience: string;
|
|
145
144
|
organization_usage?: Management.ClientGrantOrganizationUsageEnum;
|
|
@@ -159,7 +158,7 @@ export interface CreateClientGrantRequestContent {
|
|
|
159
158
|
*/
|
|
160
159
|
export interface UpdateClientGrantRequestContent {
|
|
161
160
|
/** Scopes allowed for this client grant. */
|
|
162
|
-
scope?: string[];
|
|
161
|
+
scope?: string[] | null;
|
|
163
162
|
organization_usage?: Management.ClientGrantOrganizationNullableUsageEnum | null;
|
|
164
163
|
/** Controls allowing any organization to be used with this grant */
|
|
165
164
|
allow_any_organization?: boolean | null;
|
|
@@ -179,6 +178,7 @@ export interface UpdateClientGrantRequestContent {
|
|
|
179
178
|
* is_global: true,
|
|
180
179
|
* is_first_party: true,
|
|
181
180
|
* app_type: "app_type",
|
|
181
|
+
* external_client_id: "external_client_id",
|
|
182
182
|
* q: "q"
|
|
183
183
|
* }
|
|
184
184
|
*/
|
|
@@ -199,7 +199,9 @@ export interface ListClientsRequestParameters {
|
|
|
199
199
|
is_first_party?: boolean | null;
|
|
200
200
|
/** Optional filter by a comma-separated list of application types. */
|
|
201
201
|
app_type?: string | null;
|
|
202
|
-
/**
|
|
202
|
+
/** Optional filter by the <a href="https://www.ietf.org/archive/id/draft-ietf-oauth-client-id-metadata-document-04.html">Client ID Metadata Document</a> URI for CIMD-registered clients. */
|
|
203
|
+
external_client_id?: string | null;
|
|
204
|
+
/** Advanced Query in <a href="https://lucene.apache.org/core/2_9_4/queryparsersyntax.html">Lucene</a> syntax.<br /><b>Permitted Queries</b>:<br /><ul><li><i>client_grant.organization_id:{organization_id}</i></li><li><i>client_grant.allow_any_organization:true</i></li></ul><b>Additional Restrictions</b>:<br /><ul><li>Cannot be used in combination with other filters</li><li>Requires use of the <i>from</i> and <i>take</i> paging parameters (checkpoint paginatinon)</li><li>Reduced rate limits apply. See <a href="https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations/enterprise-public">Rate Limit Configurations</a></li></ul><i><b>Note</b>: Recent updates may not be immediately reflected in query results</i> */
|
|
203
205
|
q?: string | null;
|
|
204
206
|
}
|
|
205
207
|
/**
|
|
@@ -293,6 +295,26 @@ export interface CreateClientRequestContent {
|
|
|
293
295
|
express_configuration?: Management.ExpressConfiguration;
|
|
294
296
|
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration;
|
|
295
297
|
}
|
|
298
|
+
/**
|
|
299
|
+
* @example
|
|
300
|
+
* {
|
|
301
|
+
* external_client_id: "external_client_id"
|
|
302
|
+
* }
|
|
303
|
+
*/
|
|
304
|
+
export interface PreviewCimdMetadataRequestContent {
|
|
305
|
+
/** URL to the Client ID Metadata Document */
|
|
306
|
+
external_client_id: string;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* @example
|
|
310
|
+
* {
|
|
311
|
+
* external_client_id: "external_client_id"
|
|
312
|
+
* }
|
|
313
|
+
*/
|
|
314
|
+
export interface RegisterCimdClientRequestContent {
|
|
315
|
+
/** URL to the Client ID Metadata Document. Acts as the unique identifier for upsert operations. */
|
|
316
|
+
external_client_id: string;
|
|
317
|
+
}
|
|
296
318
|
/**
|
|
297
319
|
* @example
|
|
298
320
|
* {
|
|
@@ -377,7 +399,7 @@ export interface UpdateClientRequestContent {
|
|
|
377
399
|
organization_usage?: Management.ClientOrganizationUsagePatchEnum | null;
|
|
378
400
|
organization_require_behavior?: Management.ClientOrganizationRequireBehaviorPatchEnum | null;
|
|
379
401
|
/** Defines the available methods for organization discovery during the `pre_login_prompt`. Users can discover their organization either by `email`, `organization_name` or both. */
|
|
380
|
-
organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[];
|
|
402
|
+
organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | null;
|
|
381
403
|
client_authentication_methods?: Management.ClientAuthenticationMethod | null;
|
|
382
404
|
/** Makes the use of Pushed Authorization Requests mandatory for this client */
|
|
383
405
|
require_pushed_authorization_requests?: boolean;
|
|
@@ -395,7 +417,7 @@ export interface UpdateClientRequestContent {
|
|
|
395
417
|
/** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
|
|
396
418
|
par_request_expiry?: number | null;
|
|
397
419
|
express_configuration?: Management.ExpressConfigurationOrNull | null;
|
|
398
|
-
async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration;
|
|
420
|
+
async_approval_notification_channels?: (Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration | undefined) | null;
|
|
399
421
|
}
|
|
400
422
|
/**
|
|
401
423
|
* @example
|
|
@@ -474,7 +496,7 @@ export interface CreateConnectionRequestContent {
|
|
|
474
496
|
display_name?: string;
|
|
475
497
|
strategy: Management.ConnectionIdentityProviderEnum;
|
|
476
498
|
options?: Management.ConnectionPropertiesOptions;
|
|
477
|
-
/**
|
|
499
|
+
/** Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients. */
|
|
478
500
|
enabled_clients?: string[];
|
|
479
501
|
/** <code>true</code> promotes to a domain-level connection so that third-party applications can use it. <code>false</code> does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to <code>false</code>.) */
|
|
480
502
|
is_domain_connection?: boolean;
|
|
@@ -508,7 +530,7 @@ export interface UpdateConnectionRequestContent {
|
|
|
508
530
|
display_name?: string;
|
|
509
531
|
options?: Management.UpdateConnectionOptions | null;
|
|
510
532
|
/** DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients. */
|
|
511
|
-
enabled_clients?: string[];
|
|
533
|
+
enabled_clients?: string[] | null;
|
|
512
534
|
/** <code>true</code> promotes to a domain-level connection so that third-party applications can use it. <code>false</code> does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to <code>false</code>.) */
|
|
513
535
|
is_domain_connection?: boolean;
|
|
514
536
|
/** Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. (Defaults to <code>false</code>.) */
|
|
@@ -529,7 +551,7 @@ export interface UpdateConnectionRequestContent {
|
|
|
529
551
|
* }
|
|
530
552
|
*/
|
|
531
553
|
export interface ListCustomDomainsRequestParameters {
|
|
532
|
-
/** Query in <a href ="
|
|
554
|
+
/** Query in <a href ="https://lucene.apache.org/core/2_9_4/queryparsersyntax.html">Lucene query string syntax</a>. */
|
|
533
555
|
q?: string | null;
|
|
534
556
|
/** Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. */
|
|
535
557
|
fields?: string | null;
|
|
@@ -556,6 +578,16 @@ export interface CreateCustomDomainRequestContent {
|
|
|
556
578
|
/** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided, the full domain will be used. */
|
|
557
579
|
relying_party_identifier?: string;
|
|
558
580
|
}
|
|
581
|
+
/**
|
|
582
|
+
* @example
|
|
583
|
+
* {
|
|
584
|
+
* domain: "domain"
|
|
585
|
+
* }
|
|
586
|
+
*/
|
|
587
|
+
export interface SetDefaultCustomDomainRequestContent {
|
|
588
|
+
/** The domain to set as the default custom domain. Must be a verified custom domain or the canonical domain. */
|
|
589
|
+
domain: string;
|
|
590
|
+
}
|
|
559
591
|
/**
|
|
560
592
|
* @example
|
|
561
593
|
* {}
|
|
@@ -772,7 +804,7 @@ export interface GetFlowRequestParameters {
|
|
|
772
804
|
*/
|
|
773
805
|
export interface UpdateFlowRequestContent {
|
|
774
806
|
name?: string;
|
|
775
|
-
actions?: Management.FlowAction[];
|
|
807
|
+
actions?: Management.FlowAction[] | null;
|
|
776
808
|
}
|
|
777
809
|
/**
|
|
778
810
|
* @example
|
|
@@ -1028,7 +1060,6 @@ export interface ListNetworkAclsRequestParameters {
|
|
|
1028
1060
|
* {
|
|
1029
1061
|
* description: "description",
|
|
1030
1062
|
* active: true,
|
|
1031
|
-
* priority: 1.1,
|
|
1032
1063
|
* rule: {
|
|
1033
1064
|
* action: {},
|
|
1034
1065
|
* scope: "management"
|
|
@@ -1040,7 +1071,7 @@ export interface CreateNetworkAclRequestContent {
|
|
|
1040
1071
|
/** Indicates whether or not this access control list is actively being used */
|
|
1041
1072
|
active: boolean;
|
|
1042
1073
|
/** Indicates the order in which the ACL will be evaluated relative to other ACL rules. */
|
|
1043
|
-
priority
|
|
1074
|
+
priority?: number;
|
|
1044
1075
|
rule: Management.NetworkAclRule;
|
|
1045
1076
|
}
|
|
1046
1077
|
/**
|
|
@@ -1048,7 +1079,6 @@ export interface CreateNetworkAclRequestContent {
|
|
|
1048
1079
|
* {
|
|
1049
1080
|
* description: "description",
|
|
1050
1081
|
* active: true,
|
|
1051
|
-
* priority: 1.1,
|
|
1052
1082
|
* rule: {
|
|
1053
1083
|
* action: {},
|
|
1054
1084
|
* scope: "management"
|
|
@@ -1060,7 +1090,7 @@ export interface SetNetworkAclRequestContent {
|
|
|
1060
1090
|
/** Indicates whether or not this access control list is actively being used */
|
|
1061
1091
|
active: boolean;
|
|
1062
1092
|
/** Indicates the order in which the ACL will be evaluated relative to other ACL rules. */
|
|
1063
|
-
priority
|
|
1093
|
+
priority?: number;
|
|
1064
1094
|
rule: Management.NetworkAclRule;
|
|
1065
1095
|
}
|
|
1066
1096
|
/**
|
|
@@ -1132,6 +1162,31 @@ export interface UpdateSettingsRequestContent {
|
|
|
1132
1162
|
/** Use WebAuthn with Device Biometrics as the first authentication factor */
|
|
1133
1163
|
webauthn_platform_first_factor?: boolean | null;
|
|
1134
1164
|
}
|
|
1165
|
+
/**
|
|
1166
|
+
* @example
|
|
1167
|
+
* {
|
|
1168
|
+
* user_id: "user_id",
|
|
1169
|
+
* client_id: "client_id",
|
|
1170
|
+
* from: "from",
|
|
1171
|
+
* take: 1,
|
|
1172
|
+
* fields: "fields",
|
|
1173
|
+
* include_fields: true
|
|
1174
|
+
* }
|
|
1175
|
+
*/
|
|
1176
|
+
export interface GetRefreshTokensRequestParameters {
|
|
1177
|
+
/** ID of the user whose refresh tokens to retrieve. Required. */
|
|
1178
|
+
user_id: string;
|
|
1179
|
+
/** Filter results by client ID. Only valid when user_id is provided. */
|
|
1180
|
+
client_id?: string | null;
|
|
1181
|
+
/** An opaque cursor from which to start the selection (exclusive). Expires after 24 hours. Obtained from the next property of a previous response. */
|
|
1182
|
+
from?: string | null;
|
|
1183
|
+
/** Number of results per page. Defaults to 50. */
|
|
1184
|
+
take?: number | null;
|
|
1185
|
+
/** Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. */
|
|
1186
|
+
fields?: string | null;
|
|
1187
|
+
/** Whether specified fields are to be included (true) or excluded (false). */
|
|
1188
|
+
include_fields?: boolean | null;
|
|
1189
|
+
}
|
|
1135
1190
|
/**
|
|
1136
1191
|
* @example
|
|
1137
1192
|
* {}
|
|
@@ -1179,6 +1234,8 @@ export interface CreateResourceServerRequestContent {
|
|
|
1179
1234
|
signing_secret?: string;
|
|
1180
1235
|
/** Whether refresh tokens can be issued for this API (true) or not (false). */
|
|
1181
1236
|
allow_offline_access?: boolean;
|
|
1237
|
+
/** Whether Online Refresh Tokens can be issued for this API (true) or not (false). */
|
|
1238
|
+
allow_online_access?: boolean;
|
|
1182
1239
|
/** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */
|
|
1183
1240
|
token_lifetime?: number;
|
|
1184
1241
|
token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
|
|
@@ -1188,7 +1245,7 @@ export interface CreateResourceServerRequestContent {
|
|
|
1188
1245
|
enforce_policies?: boolean;
|
|
1189
1246
|
token_encryption?: Management.ResourceServerTokenEncryption | null;
|
|
1190
1247
|
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
|
|
1191
|
-
authorization_details?: unknown[];
|
|
1248
|
+
authorization_details?: unknown[] | null;
|
|
1192
1249
|
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
|
|
1193
1250
|
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
|
|
1194
1251
|
}
|
|
@@ -1218,6 +1275,8 @@ export interface UpdateResourceServerRequestContent {
|
|
|
1218
1275
|
skip_consent_for_verifiable_first_party_clients?: boolean;
|
|
1219
1276
|
/** Whether refresh tokens can be issued for this API (true) or not (false). */
|
|
1220
1277
|
allow_offline_access?: boolean;
|
|
1278
|
+
/** Whether Online Refresh Tokens can be issued for this API (true) or not (false). */
|
|
1279
|
+
allow_online_access?: boolean;
|
|
1221
1280
|
/** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */
|
|
1222
1281
|
token_lifetime?: number;
|
|
1223
1282
|
token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
|
|
@@ -1225,7 +1284,7 @@ export interface UpdateResourceServerRequestContent {
|
|
|
1225
1284
|
enforce_policies?: boolean;
|
|
1226
1285
|
token_encryption?: Management.ResourceServerTokenEncryption | null;
|
|
1227
1286
|
consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
|
|
1228
|
-
authorization_details?: unknown[];
|
|
1287
|
+
authorization_details?: unknown[] | null;
|
|
1229
1288
|
proof_of_possession?: Management.ResourceServerProofOfPossession | null;
|
|
1230
1289
|
subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
|
|
1231
1290
|
}
|
|
@@ -1629,7 +1688,7 @@ export interface ListUsersRequestParameters {
|
|
|
1629
1688
|
fields?: string | null;
|
|
1630
1689
|
/** Whether specified fields are to be included (true) or excluded (false). */
|
|
1631
1690
|
include_fields?: boolean | null;
|
|
1632
|
-
/** Query in <a target='_new' href ='
|
|
1691
|
+
/** Query in <a target='_new' href ='https://lucene.apache.org/core/2_9_4/queryparsersyntax.html'>Lucene query string syntax</a>. Some query types cannot be used on metadata fields, for details see <a href='https://auth0.com/docs/users/search/v3/query-syntax#searchable-fields'>Searchable Fields</a>. */
|
|
1633
1692
|
q?: string | null;
|
|
1634
1693
|
/** The version of the search engine */
|
|
1635
1694
|
search_engine?: Management.SearchEngineVersionsEnum | null;
|
|
@@ -2241,6 +2300,8 @@ export interface PostClientCredentialRequestContent {
|
|
|
2241
2300
|
parse_expiry_from_cert?: boolean;
|
|
2242
2301
|
/** The ISO 8601 formatted date representing the expiration of the credential. If not specified (not recommended), the credential never expires. Applies to `public_key` credential type. */
|
|
2243
2302
|
expires_at?: string;
|
|
2303
|
+
/** Optional kid (Key ID), used to uniquely identify the credential. If not specified, a kid value will be auto-generated. The kid header parameter in JWTs sent by your client should match this value. Valid format is [0-9a-zA-Z-_]{10,64} */
|
|
2304
|
+
kid?: string;
|
|
2244
2305
|
}
|
|
2245
2306
|
/**
|
|
2246
2307
|
* @example
|
|
@@ -2824,6 +2885,63 @@ export interface AssociateOrganizationClientGrantRequestContent {
|
|
|
2824
2885
|
/** A Client Grant ID to add to the organization. */
|
|
2825
2886
|
grant_id: string;
|
|
2826
2887
|
}
|
|
2888
|
+
/**
|
|
2889
|
+
* @example
|
|
2890
|
+
* {
|
|
2891
|
+
* page: 1,
|
|
2892
|
+
* per_page: 1,
|
|
2893
|
+
* include_totals: true,
|
|
2894
|
+
* is_enabled: true
|
|
2895
|
+
* }
|
|
2896
|
+
*/
|
|
2897
|
+
export interface ListOrganizationAllConnectionsRequestParameters {
|
|
2898
|
+
/** Page index of the results to return. First page is 0. */
|
|
2899
|
+
page?: number | null;
|
|
2900
|
+
/** Number of results per page. Defaults to 50. */
|
|
2901
|
+
per_page?: number | null;
|
|
2902
|
+
/** Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). */
|
|
2903
|
+
include_totals?: boolean | null;
|
|
2904
|
+
/** Filter connections by enabled status. */
|
|
2905
|
+
is_enabled?: boolean | null;
|
|
2906
|
+
}
|
|
2907
|
+
/**
|
|
2908
|
+
* @example
|
|
2909
|
+
* {
|
|
2910
|
+
* connection_id: "connection_id"
|
|
2911
|
+
* }
|
|
2912
|
+
*/
|
|
2913
|
+
export interface CreateOrganizationAllConnectionRequestParameters {
|
|
2914
|
+
/** Name of the connection in the scope of this organization. */
|
|
2915
|
+
organization_connection_name?: string;
|
|
2916
|
+
/** When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection. */
|
|
2917
|
+
assign_membership_on_login?: boolean;
|
|
2918
|
+
/** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */
|
|
2919
|
+
show_as_button?: boolean;
|
|
2920
|
+
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
|
|
2921
|
+
is_signup_enabled?: boolean;
|
|
2922
|
+
organization_access_level?: Management.OrganizationAccessLevelEnum;
|
|
2923
|
+
/** Whether the connection is enabled for the organization. */
|
|
2924
|
+
is_enabled?: boolean;
|
|
2925
|
+
/** Connection identifier. */
|
|
2926
|
+
connection_id: string;
|
|
2927
|
+
}
|
|
2928
|
+
/**
|
|
2929
|
+
* @example
|
|
2930
|
+
* {}
|
|
2931
|
+
*/
|
|
2932
|
+
export interface UpdateOrganizationConnectionRequestParameters {
|
|
2933
|
+
/** Name of the connection in the scope of this organization. */
|
|
2934
|
+
organization_connection_name?: string | null;
|
|
2935
|
+
/** When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection. */
|
|
2936
|
+
assign_membership_on_login?: boolean;
|
|
2937
|
+
/** Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true. */
|
|
2938
|
+
show_as_button?: boolean;
|
|
2939
|
+
/** Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false. */
|
|
2940
|
+
is_signup_enabled?: boolean;
|
|
2941
|
+
organization_access_level?: Management.OrganizationAccessLevelEnumWithNull | null;
|
|
2942
|
+
/** Whether the connection is enabled for the organization. */
|
|
2943
|
+
is_enabled?: boolean | null;
|
|
2944
|
+
}
|
|
2827
2945
|
/**
|
|
2828
2946
|
* @example
|
|
2829
2947
|
* {
|
|
@@ -3094,13 +3212,13 @@ export interface BulkUpdateAculRequestContent {
|
|
|
3094
3212
|
export interface UpdateAculRequestContent {
|
|
3095
3213
|
/** Rendering mode */
|
|
3096
3214
|
rendering_mode?: Management.AculRenderingModeEnum;
|
|
3097
|
-
context_configuration?: Management.AculContextConfiguration;
|
|
3215
|
+
context_configuration?: (Management.AculContextConfiguration | undefined) | null;
|
|
3098
3216
|
/** Override Universal Login default head tags */
|
|
3099
3217
|
default_head_tags_disabled?: boolean | null;
|
|
3100
3218
|
/** Use page template with ACUL */
|
|
3101
3219
|
use_page_template?: boolean | null;
|
|
3102
3220
|
/** An array of head tags */
|
|
3103
|
-
head_tags?: Management.AculHeadTag[];
|
|
3221
|
+
head_tags?: Management.AculHeadTag[] | null;
|
|
3104
3222
|
filters?: Management.AculFilters | null;
|
|
3105
3223
|
}
|
|
3106
3224
|
/**
|
|
@@ -3270,7 +3388,7 @@ export interface UpdateTenantSettingsRequestContent {
|
|
|
3270
3388
|
/** Whether to accept an organization name instead of an ID on auth endpoints */
|
|
3271
3389
|
allow_organization_name_in_authentication_api?: boolean | null;
|
|
3272
3390
|
/** Supported ACR values */
|
|
3273
|
-
acr_values_supported?: string[];
|
|
3391
|
+
acr_values_supported?: string[] | null;
|
|
3274
3392
|
mtls?: Management.TenantSettingsMtls | null;
|
|
3275
3393
|
/** Enables the use of Pushed Authorization Requests */
|
|
3276
3394
|
pushed_authorization_requests_supported?: boolean | null;
|
|
@@ -35,7 +35,7 @@ export declare class ActionsClient {
|
|
|
35
35
|
*
|
|
36
36
|
* @example
|
|
37
37
|
* await client.actions.list({
|
|
38
|
-
* triggerId: "
|
|
38
|
+
* triggerId: "post-login",
|
|
39
39
|
* actionName: "actionName",
|
|
40
40
|
* deployed: true,
|
|
41
41
|
* page: 1,
|
|
@@ -59,7 +59,7 @@ export declare class ActionsClient {
|
|
|
59
59
|
* await client.actions.create({
|
|
60
60
|
* name: "name",
|
|
61
61
|
* supported_triggers: [{
|
|
62
|
-
* id: "
|
|
62
|
+
* id: "post-login"
|
|
63
63
|
* }]
|
|
64
64
|
* })
|
|
65
65
|
*/
|
|
@@ -52,7 +52,7 @@ export class ActionsClient {
|
|
|
52
52
|
*
|
|
53
53
|
* @example
|
|
54
54
|
* await client.actions.list({
|
|
55
|
-
* triggerId: "
|
|
55
|
+
* triggerId: "post-login",
|
|
56
56
|
* actionName: "actionName",
|
|
57
57
|
* deployed: true,
|
|
58
58
|
* page: 1,
|
|
@@ -66,7 +66,7 @@ export class ActionsClient {
|
|
|
66
66
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
67
67
|
const { triggerId, actionName, deployed, page = 0, per_page: perPage = 50, installed } = request;
|
|
68
68
|
const _queryParams = {
|
|
69
|
-
triggerId,
|
|
69
|
+
triggerId: triggerId !== undefined ? triggerId : undefined,
|
|
70
70
|
actionName,
|
|
71
71
|
deployed,
|
|
72
72
|
page,
|
|
@@ -141,7 +141,7 @@ export class ActionsClient {
|
|
|
141
141
|
* await client.actions.create({
|
|
142
142
|
* name: "name",
|
|
143
143
|
* supported_triggers: [{
|
|
144
|
-
* id: "
|
|
144
|
+
* id: "post-login"
|
|
145
145
|
* }]
|
|
146
146
|
* })
|
|
147
147
|
*/
|
|
@@ -23,7 +23,7 @@ export declare class BindingsClient {
|
|
|
23
23
|
* @throws {@link Management.TooManyRequestsError}
|
|
24
24
|
*
|
|
25
25
|
* @example
|
|
26
|
-
* await client.actions.triggers.bindings.list("
|
|
26
|
+
* await client.actions.triggers.bindings.list("post-login", {
|
|
27
27
|
* page: 1,
|
|
28
28
|
* per_page: 1
|
|
29
29
|
* })
|
|
@@ -42,7 +42,7 @@ export declare class BindingsClient {
|
|
|
42
42
|
* @throws {@link Management.TooManyRequestsError}
|
|
43
43
|
*
|
|
44
44
|
* @example
|
|
45
|
-
* await client.actions.triggers.bindings.updateMany("
|
|
45
|
+
* await client.actions.triggers.bindings.updateMany("post-login")
|
|
46
46
|
*/
|
|
47
47
|
updateMany(triggerId: Management.ActionTriggerTypeEnum, request?: Management.UpdateActionBindingsRequestContent, requestOptions?: BindingsClient.RequestOptions): core.HttpResponsePromise<Management.UpdateActionBindingsResponseContent>;
|
|
48
48
|
private __updateMany;
|
|
@@ -32,7 +32,7 @@ export class BindingsClient {
|
|
|
32
32
|
* @throws {@link Management.TooManyRequestsError}
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
|
-
* await client.actions.triggers.bindings.list("
|
|
35
|
+
* await client.actions.triggers.bindings.list("post-login", {
|
|
36
36
|
* page: 1,
|
|
37
37
|
* per_page: 1
|
|
38
38
|
* })
|
|
@@ -112,7 +112,7 @@ export class BindingsClient {
|
|
|
112
112
|
* @throws {@link Management.TooManyRequestsError}
|
|
113
113
|
*
|
|
114
114
|
* @example
|
|
115
|
-
* await client.actions.triggers.bindings.updateMany("
|
|
115
|
+
* await client.actions.triggers.bindings.updateMany("post-login")
|
|
116
116
|
*/
|
|
117
117
|
updateMany(triggerId, request = {}, requestOptions) {
|
|
118
118
|
return core.HttpResponsePromise.fromPromise(this.__updateMany(triggerId, request, requestOptions));
|
|
@@ -69,6 +69,7 @@ export declare class ClientsClient {
|
|
|
69
69
|
* is_global: true,
|
|
70
70
|
* is_first_party: true,
|
|
71
71
|
* app_type: "app_type",
|
|
72
|
+
* external_client_id: "external_client_id",
|
|
72
73
|
* q: "q"
|
|
73
74
|
* })
|
|
74
75
|
*/
|
|
@@ -105,6 +106,51 @@ export declare class ClientsClient {
|
|
|
105
106
|
*/
|
|
106
107
|
create(request: Management.CreateClientRequestContent, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<Management.CreateClientResponseContent>;
|
|
107
108
|
private __create;
|
|
109
|
+
/**
|
|
110
|
+
*
|
|
111
|
+
* Fetches and validates a Client ID Metadata Document without creating a client.
|
|
112
|
+
* Returns the raw metadata and how it would be mapped to Auth0 client fields.
|
|
113
|
+
* This endpoint is useful for testing metadata URIs before creating CIMD clients.
|
|
114
|
+
*
|
|
115
|
+
*
|
|
116
|
+
* @param {Management.PreviewCimdMetadataRequestContent} request
|
|
117
|
+
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link Management.BadRequestError}
|
|
120
|
+
* @throws {@link Management.UnauthorizedError}
|
|
121
|
+
* @throws {@link Management.ForbiddenError}
|
|
122
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
123
|
+
* @throws {@link Management.InternalServerError}
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* await client.clients.previewCimdMetadata({
|
|
127
|
+
* external_client_id: "external_client_id"
|
|
128
|
+
* })
|
|
129
|
+
*/
|
|
130
|
+
previewCimdMetadata(request: Management.PreviewCimdMetadataRequestContent, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<Management.PreviewCimdMetadataResponseContent>;
|
|
131
|
+
private __previewCimdMetadata;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* Idempotent registration for Client ID Metadata Document (CIMD) clients.
|
|
135
|
+
* Uses external_client_id as the unique identifier for upsert operations.
|
|
136
|
+
* **Create:** Returns 201 when a new client is created (requires \
|
|
137
|
+
*
|
|
138
|
+
* @param {Management.RegisterCimdClientRequestContent} request
|
|
139
|
+
* @param {ClientsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link Management.BadRequestError}
|
|
142
|
+
* @throws {@link Management.UnauthorizedError}
|
|
143
|
+
* @throws {@link Management.ForbiddenError}
|
|
144
|
+
* @throws {@link Management.TooManyRequestsError}
|
|
145
|
+
* @throws {@link Management.InternalServerError}
|
|
146
|
+
*
|
|
147
|
+
* @example
|
|
148
|
+
* await client.clients.registerCimdClient({
|
|
149
|
+
* external_client_id: "external_client_id"
|
|
150
|
+
* })
|
|
151
|
+
*/
|
|
152
|
+
registerCimdClient(request: Management.RegisterCimdClientRequestContent, requestOptions?: ClientsClient.RequestOptions): core.HttpResponsePromise<Management.RegisterCimdClientResponseContent>;
|
|
153
|
+
private __registerCimdClient;
|
|
108
154
|
/**
|
|
109
155
|
* Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified.
|
|
110
156
|
* For more information, read <a href="https://www.auth0.com/docs/get-started/applications"> Applications in Auth0</a> and <a href="https://www.auth0.com/docs/authenticate/single-sign-on"> Single Sign-On</a>.
|