auth0 5.4.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.
Files changed (116) hide show
  1. package/dist/cjs/management/Client.d.ts +12 -0
  2. package/dist/cjs/management/Client.js +67 -0
  3. package/dist/cjs/management/api/requests/requests.d.ts +156 -22
  4. package/dist/cjs/management/api/resources/actions/client/Client.d.ts +2 -2
  5. package/dist/cjs/management/api/resources/actions/client/Client.js +3 -3
  6. package/dist/cjs/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.d.ts +2 -2
  7. package/dist/cjs/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.js +2 -2
  8. package/dist/cjs/management/api/resources/clientGrants/client/Client.d.ts +0 -1
  9. package/dist/cjs/management/api/resources/clientGrants/client/Client.js +0 -1
  10. package/dist/cjs/management/api/resources/clients/client/Client.d.ts +46 -0
  11. package/dist/cjs/management/api/resources/clients/client/Client.js +146 -1
  12. package/dist/cjs/management/api/resources/customDomains/client/Client.d.ts +30 -0
  13. package/dist/cjs/management/api/resources/customDomains/client/Client.js +115 -0
  14. package/dist/cjs/management/api/resources/groups/client/Client.d.ts +16 -0
  15. package/dist/cjs/management/api/resources/groups/client/Client.js +57 -0
  16. package/dist/cjs/management/api/resources/networkAcls/client/Client.d.ts +0 -2
  17. package/dist/cjs/management/api/resources/networkAcls/client/Client.js +0 -2
  18. package/dist/cjs/management/api/resources/organizations/client/Client.d.ts +3 -0
  19. package/dist/cjs/management/api/resources/organizations/client/Client.js +13 -8
  20. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.d.ts +95 -0
  21. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +383 -0
  22. package/dist/cjs/management/api/resources/organizations/resources/connections/client/index.d.ts +1 -0
  23. package/dist/cjs/management/api/resources/organizations/resources/connections/client/index.js +2 -0
  24. package/dist/cjs/management/api/resources/organizations/resources/connections/index.d.ts +1 -0
  25. package/dist/cjs/management/api/resources/organizations/resources/connections/index.js +17 -0
  26. package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.ts +3 -1
  27. package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +3 -1
  28. package/dist/cjs/management/api/resources/organizations/resources/index.d.ts +1 -0
  29. package/dist/cjs/management/api/resources/organizations/resources/index.js +2 -1
  30. package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +23 -0
  31. package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +88 -0
  32. package/dist/cjs/management/api/types/types.d.ts +508 -292
  33. package/dist/cjs/management/api/types/types.js +101 -103
  34. package/dist/cjs/management/core/auth/BasicAuth.d.ts +2 -2
  35. package/dist/cjs/management/core/auth/BasicAuth.js +7 -1
  36. package/dist/cjs/management/core/fetcher/BinaryResponse.d.ts +1 -1
  37. package/dist/cjs/management/core/fetcher/Fetcher.d.ts +2 -0
  38. package/dist/cjs/management/core/fetcher/Fetcher.js +5 -1
  39. package/dist/cjs/management/core/fetcher/index.d.ts +2 -0
  40. package/dist/cjs/management/core/fetcher/index.js +3 -1
  41. package/dist/cjs/management/core/fetcher/makePassthroughRequest.d.ts +49 -0
  42. package/dist/cjs/management/core/fetcher/makePassthroughRequest.js +135 -0
  43. package/dist/cjs/management/core/fetcher/makeRequest.d.ts +6 -1
  44. package/dist/cjs/management/core/fetcher/makeRequest.js +30 -9
  45. package/dist/cjs/management/core/pagination/Page.d.ts +1 -1
  46. package/dist/cjs/management/core/pagination/index.d.ts +0 -1
  47. package/dist/cjs/management/core/pagination/index.js +1 -4
  48. package/dist/cjs/management/core/runtime/runtime.js +8 -7
  49. package/dist/cjs/management/errors/ManagementError.d.ts +3 -1
  50. package/dist/cjs/management/errors/ManagementError.js +4 -1
  51. package/dist/cjs/management/errors/ManagementTimeoutError.d.ts +4 -1
  52. package/dist/cjs/management/errors/ManagementTimeoutError.js +4 -1
  53. package/dist/cjs/management/errors/handleNonStatusCodeError.js +4 -1
  54. package/dist/cjs/management/version.d.ts +1 -1
  55. package/dist/cjs/management/version.js +1 -1
  56. package/dist/esm/management/Client.d.mts +12 -0
  57. package/dist/esm/management/Client.mjs +34 -0
  58. package/dist/esm/management/api/requests/requests.d.mts +156 -22
  59. package/dist/esm/management/api/resources/actions/client/Client.d.mts +2 -2
  60. package/dist/esm/management/api/resources/actions/client/Client.mjs +3 -3
  61. package/dist/esm/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.d.mts +2 -2
  62. package/dist/esm/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.mjs +2 -2
  63. package/dist/esm/management/api/resources/clientGrants/client/Client.d.mts +0 -1
  64. package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +0 -1
  65. package/dist/esm/management/api/resources/clients/client/Client.d.mts +46 -0
  66. package/dist/esm/management/api/resources/clients/client/Client.mjs +146 -1
  67. package/dist/esm/management/api/resources/customDomains/client/Client.d.mts +30 -0
  68. package/dist/esm/management/api/resources/customDomains/client/Client.mjs +115 -0
  69. package/dist/esm/management/api/resources/groups/client/Client.d.mts +16 -0
  70. package/dist/esm/management/api/resources/groups/client/Client.mjs +57 -0
  71. package/dist/esm/management/api/resources/networkAcls/client/Client.d.mts +0 -2
  72. package/dist/esm/management/api/resources/networkAcls/client/Client.mjs +0 -2
  73. package/dist/esm/management/api/resources/organizations/client/Client.d.mts +3 -0
  74. package/dist/esm/management/api/resources/organizations/client/Client.mjs +5 -0
  75. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.d.mts +95 -0
  76. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +346 -0
  77. package/dist/esm/management/api/resources/organizations/resources/connections/client/index.d.mts +1 -0
  78. package/dist/esm/management/api/resources/organizations/resources/connections/client/index.mjs +1 -0
  79. package/dist/esm/management/api/resources/organizations/resources/connections/index.d.mts +1 -0
  80. package/dist/esm/management/api/resources/organizations/resources/connections/index.mjs +1 -0
  81. package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.d.mts +3 -1
  82. package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +3 -1
  83. package/dist/esm/management/api/resources/organizations/resources/index.d.mts +1 -0
  84. package/dist/esm/management/api/resources/organizations/resources/index.mjs +1 -0
  85. package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +23 -0
  86. package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +88 -0
  87. package/dist/esm/management/api/types/types.d.mts +508 -292
  88. package/dist/esm/management/api/types/types.mjs +91 -93
  89. package/dist/esm/management/core/auth/BasicAuth.d.mts +2 -2
  90. package/dist/esm/management/core/auth/BasicAuth.mjs +7 -1
  91. package/dist/esm/management/core/fetcher/BinaryResponse.d.mts +1 -1
  92. package/dist/esm/management/core/fetcher/Fetcher.d.mts +2 -0
  93. package/dist/esm/management/core/fetcher/Fetcher.mjs +5 -1
  94. package/dist/esm/management/core/fetcher/index.d.mts +2 -0
  95. package/dist/esm/management/core/fetcher/index.mjs +1 -0
  96. package/dist/esm/management/core/fetcher/makePassthroughRequest.d.mts +49 -0
  97. package/dist/esm/management/core/fetcher/makePassthroughRequest.mjs +132 -0
  98. package/dist/esm/management/core/fetcher/makeRequest.d.mts +6 -1
  99. package/dist/esm/management/core/fetcher/makeRequest.mjs +28 -9
  100. package/dist/esm/management/core/pagination/Page.d.mts +1 -1
  101. package/dist/esm/management/core/pagination/index.d.mts +0 -1
  102. package/dist/esm/management/core/pagination/index.mjs +0 -1
  103. package/dist/esm/management/core/runtime/runtime.mjs +8 -7
  104. package/dist/esm/management/errors/ManagementError.d.mts +3 -1
  105. package/dist/esm/management/errors/ManagementError.mjs +4 -1
  106. package/dist/esm/management/errors/ManagementTimeoutError.d.mts +4 -1
  107. package/dist/esm/management/errors/ManagementTimeoutError.mjs +4 -1
  108. package/dist/esm/management/errors/handleNonStatusCodeError.mjs +4 -1
  109. package/dist/esm/management/version.d.mts +1 -1
  110. package/dist/esm/management/version.mjs +1 -1
  111. package/package.json +5 -6
  112. package/reference.md +752 -30
  113. package/dist/cjs/management/core/pagination/CustomPager.d.ts +0 -67
  114. package/dist/cjs/management/core/pagination/CustomPager.js +0 -194
  115. package/dist/esm/management/core/pagination/CustomPager.d.mts +0 -67
  116. 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: "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: "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: string;
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
- /** Advanced Query in <a href="http://www.lucenetutorial.com/lucene-query-syntax.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> */
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
  /**
@@ -218,6 +220,7 @@ export interface CreateClientRequestContent {
218
220
  /** Comma-separated list of URLs whitelisted for Auth0 to use as a callback to the client after authentication. */
219
221
  callbacks?: string[];
220
222
  oidc_logout?: Management.ClientOidcBackchannelLogoutSettings;
223
+ /** Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout) */
221
224
  oidc_backchannel_logout?: Management.ClientOidcBackchannelLogoutSettings;
222
225
  session_transfer?: Management.ClientSessionTransferConfiguration | null;
223
226
  /** Comma-separated list of URLs allowed to make requests from JavaScript to Auth0 API (typically used with CORS). By default, all your callback URLs will be allowed. This field allows you to enter other origins if necessary. You can also use wildcards at the subdomain level (e.g., https://*.contoso.com). Query strings and hash information are not taken into account when validating these URLs. */
@@ -292,6 +295,26 @@ export interface CreateClientRequestContent {
292
295
  express_configuration?: Management.ExpressConfiguration;
293
296
  async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPostConfiguration;
294
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
+ }
295
318
  /**
296
319
  * @example
297
320
  * {
@@ -321,6 +344,7 @@ export interface UpdateClientRequestContent {
321
344
  /** A set of URLs that are valid to call back from Auth0 when authenticating users */
322
345
  callbacks?: string[];
323
346
  oidc_logout?: Management.ClientOidcBackchannelLogoutSettings;
347
+ /** Configuration for OIDC backchannel logout (deprecated, in favor of oidc_logout) */
324
348
  oidc_backchannel_logout?: Management.ClientOidcBackchannelLogoutSettings;
325
349
  session_transfer?: Management.ClientSessionTransferConfiguration | null;
326
350
  /** A set of URLs that represents valid origins for CORS */
@@ -335,7 +359,9 @@ export interface UpdateClientRequestContent {
335
359
  allowed_clients?: string[];
336
360
  /** URLs that are valid to redirect to after logout from Auth0 */
337
361
  allowed_logout_urls?: string[];
362
+ /** An object that holds settings related to how JWTs are created */
338
363
  jwt_configuration?: Management.ClientJwtConfiguration;
364
+ /** The client's encryption key */
339
365
  encryption_key?: Management.ClientEncryptionKey | null;
340
366
  /** <code>true</code> to use Auth0 instead of the IdP to do Single Sign On, <code>false</code> otherwise (default: <code>false</code>) */
341
367
  sso?: boolean;
@@ -363,6 +389,7 @@ export interface UpdateClientRequestContent {
363
389
  form_template?: string;
364
390
  addons?: Management.ClientAddons;
365
391
  client_metadata?: Management.ClientMetadata;
392
+ /** Configuration related to native mobile apps */
366
393
  mobile?: Management.ClientMobile;
367
394
  /** Initiate login uri, must be https */
368
395
  initiate_login_uri?: string;
@@ -372,7 +399,7 @@ export interface UpdateClientRequestContent {
372
399
  organization_usage?: Management.ClientOrganizationUsagePatchEnum | null;
373
400
  organization_require_behavior?: Management.ClientOrganizationRequireBehaviorPatchEnum | null;
374
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. */
375
- organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[];
402
+ organization_discovery_methods?: Management.ClientOrganizationDiscoveryEnum[] | null;
376
403
  client_authentication_methods?: Management.ClientAuthenticationMethod | null;
377
404
  /** Makes the use of Pushed Authorization Requests mandatory for this client */
378
405
  require_pushed_authorization_requests?: boolean;
@@ -390,7 +417,7 @@ export interface UpdateClientRequestContent {
390
417
  /** Specifies how long, in seconds, a Pushed Authorization Request URI remains valid */
391
418
  par_request_expiry?: number | null;
392
419
  express_configuration?: Management.ExpressConfigurationOrNull | null;
393
- async_approval_notification_channels?: Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration;
420
+ async_approval_notification_channels?: (Management.ClientAsyncApprovalNotificationsChannelsApiPatchConfiguration | undefined) | null;
394
421
  }
395
422
  /**
396
423
  * @example
@@ -469,7 +496,7 @@ export interface CreateConnectionRequestContent {
469
496
  display_name?: string;
470
497
  strategy: Management.ConnectionIdentityProviderEnum;
471
498
  options?: Management.ConnectionPropertiesOptions;
472
- /** DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients. */
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. */
473
500
  enabled_clients?: string[];
474
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>.) */
475
502
  is_domain_connection?: boolean;
@@ -503,7 +530,7 @@ export interface UpdateConnectionRequestContent {
503
530
  display_name?: string;
504
531
  options?: Management.UpdateConnectionOptions | null;
505
532
  /** DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients. */
506
- enabled_clients?: string[];
533
+ enabled_clients?: string[] | null;
507
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>.) */
508
535
  is_domain_connection?: boolean;
509
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>.) */
@@ -524,7 +551,7 @@ export interface UpdateConnectionRequestContent {
524
551
  * }
525
552
  */
526
553
  export interface ListCustomDomainsRequestParameters {
527
- /** Query in <a href ="http://www.lucenetutorial.com/lucene-query-syntax.html">Lucene query string syntax</a>. */
554
+ /** Query in <a href ="https://lucene.apache.org/core/2_9_4/queryparsersyntax.html">Lucene query string syntax</a>. */
528
555
  q?: string | null;
529
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. */
530
557
  fields?: string | null;
@@ -551,11 +578,22 @@ export interface CreateCustomDomainRequestContent {
551
578
  /** Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not provided, the full domain will be used. */
552
579
  relying_party_identifier?: string;
553
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
+ }
554
591
  /**
555
592
  * @example
556
593
  * {}
557
594
  */
558
595
  export interface UpdateCustomDomainRequestContent {
596
+ /** recommended includes TLS 1.2 */
559
597
  tls_policy?: Management.CustomDomainTlsPolicyEnum;
560
598
  custom_client_ip_header?: Management.CustomDomainCustomClientIpHeader | undefined;
561
599
  domain_metadata?: Management.DomainMetadata;
@@ -766,7 +804,7 @@ export interface GetFlowRequestParameters {
766
804
  */
767
805
  export interface UpdateFlowRequestContent {
768
806
  name?: string;
769
- actions?: Management.FlowAction[];
807
+ actions?: Management.FlowAction[] | null;
770
808
  }
771
809
  /**
772
810
  * @example
@@ -928,6 +966,7 @@ export interface CreateHookRequestContent {
928
966
  /** Whether this hook will be executed (true) or ignored (false). */
929
967
  enabled?: boolean;
930
968
  dependencies?: Management.HookDependencies;
969
+ /** Execution stage of this rule. Can be `credentials-exchange`, `pre-user-registration`, `post-user-registration`, `post-change-password`, or `send-phone-message`. */
931
970
  triggerId: Management.HookTriggerIdEnum;
932
971
  }
933
972
  /**
@@ -1021,7 +1060,6 @@ export interface ListNetworkAclsRequestParameters {
1021
1060
  * {
1022
1061
  * description: "description",
1023
1062
  * active: true,
1024
- * priority: 1.1,
1025
1063
  * rule: {
1026
1064
  * action: {},
1027
1065
  * scope: "management"
@@ -1033,7 +1071,7 @@ export interface CreateNetworkAclRequestContent {
1033
1071
  /** Indicates whether or not this access control list is actively being used */
1034
1072
  active: boolean;
1035
1073
  /** Indicates the order in which the ACL will be evaluated relative to other ACL rules. */
1036
- priority: number;
1074
+ priority?: number;
1037
1075
  rule: Management.NetworkAclRule;
1038
1076
  }
1039
1077
  /**
@@ -1041,7 +1079,6 @@ export interface CreateNetworkAclRequestContent {
1041
1079
  * {
1042
1080
  * description: "description",
1043
1081
  * active: true,
1044
- * priority: 1.1,
1045
1082
  * rule: {
1046
1083
  * action: {},
1047
1084
  * scope: "management"
@@ -1053,7 +1090,7 @@ export interface SetNetworkAclRequestContent {
1053
1090
  /** Indicates whether or not this access control list is actively being used */
1054
1091
  active: boolean;
1055
1092
  /** Indicates the order in which the ACL will be evaluated relative to other ACL rules. */
1056
- priority: number;
1093
+ priority?: number;
1057
1094
  rule: Management.NetworkAclRule;
1058
1095
  }
1059
1096
  /**
@@ -1125,11 +1162,37 @@ export interface UpdateSettingsRequestContent {
1125
1162
  /** Use WebAuthn with Device Biometrics as the first authentication factor */
1126
1163
  webauthn_platform_first_factor?: boolean | null;
1127
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
+ }
1128
1190
  /**
1129
1191
  * @example
1130
1192
  * {}
1131
1193
  */
1132
1194
  export interface UpdateRefreshTokenRequestContent {
1195
+ /** Metadata associated with the refresh token. Pass null or {} to remove all metadata. */
1133
1196
  refresh_token_metadata?: (Management.RefreshTokenMetadata | undefined) | null;
1134
1197
  }
1135
1198
  /**
@@ -1171,6 +1234,8 @@ export interface CreateResourceServerRequestContent {
1171
1234
  signing_secret?: string;
1172
1235
  /** Whether refresh tokens can be issued for this API (true) or not (false). */
1173
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;
1174
1239
  /** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */
1175
1240
  token_lifetime?: number;
1176
1241
  token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
@@ -1180,7 +1245,7 @@ export interface CreateResourceServerRequestContent {
1180
1245
  enforce_policies?: boolean;
1181
1246
  token_encryption?: Management.ResourceServerTokenEncryption | null;
1182
1247
  consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
1183
- authorization_details?: unknown[];
1248
+ authorization_details?: unknown[] | null;
1184
1249
  proof_of_possession?: Management.ResourceServerProofOfPossession | null;
1185
1250
  subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
1186
1251
  }
@@ -1210,6 +1275,8 @@ export interface UpdateResourceServerRequestContent {
1210
1275
  skip_consent_for_verifiable_first_party_clients?: boolean;
1211
1276
  /** Whether refresh tokens can be issued for this API (true) or not (false). */
1212
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;
1213
1280
  /** Expiration value (in seconds) for access tokens issued for this API from the token endpoint. */
1214
1281
  token_lifetime?: number;
1215
1282
  token_dialect?: Management.ResourceServerTokenDialectSchemaEnum;
@@ -1217,7 +1284,7 @@ export interface UpdateResourceServerRequestContent {
1217
1284
  enforce_policies?: boolean;
1218
1285
  token_encryption?: Management.ResourceServerTokenEncryption | null;
1219
1286
  consent_policy?: Management.ResourceServerConsentPolicyEnum | null;
1220
- authorization_details?: unknown[];
1287
+ authorization_details?: unknown[] | null;
1221
1288
  proof_of_possession?: Management.ResourceServerProofOfPossession | null;
1222
1289
  subject_type_authorization?: Management.ResourceServerSubjectTypeAuthorization;
1223
1290
  }
@@ -1396,6 +1463,7 @@ export interface UpdateSelfServiceProfileRequestContent {
1396
1463
  * {}
1397
1464
  */
1398
1465
  export interface UpdateSessionRequestContent {
1466
+ /** Metadata associated with the session. Pass null or {} to remove all session_metadata. */
1399
1467
  session_metadata?: (Management.SessionMetadata | undefined) | null;
1400
1468
  }
1401
1469
  /**
@@ -1620,7 +1688,7 @@ export interface ListUsersRequestParameters {
1620
1688
  fields?: string | null;
1621
1689
  /** Whether specified fields are to be included (true) or excluded (false). */
1622
1690
  include_fields?: boolean | null;
1623
- /** Query in <a target='_new' href ='http://www.lucenetutorial.com/lucene-query-syntax.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>. */
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>. */
1624
1692
  q?: string | null;
1625
1693
  /** The version of the search engine */
1626
1694
  search_engine?: Management.SearchEngineVersionsEnum | null;
@@ -1711,7 +1779,9 @@ export interface UpdateUserRequestContent {
1711
1779
  phone_number?: string | null;
1712
1780
  /** Whether this phone number has been verified (true) or not (false). */
1713
1781
  phone_verified?: boolean;
1782
+ /** User metadata to which this user has read/write access. */
1714
1783
  user_metadata?: Management.UserMetadata;
1784
+ /** User metadata to which this user has read-only access. */
1715
1785
  app_metadata?: Management.AppMetadata;
1716
1786
  /** Given name/first name/forename of this user. */
1717
1787
  given_name?: string | null;
@@ -2195,6 +2265,7 @@ export interface UpdatePhoneTemplateRequestContent {
2195
2265
  export interface CreatePhoneTemplateTestNotificationRequestContent {
2196
2266
  /** Destination of the testing phone notification */
2197
2267
  to: string;
2268
+ /** Medium to use to send the notification */
2198
2269
  delivery_method?: Management.PhoneProviderDeliveryMethodEnum;
2199
2270
  }
2200
2271
  /**
@@ -2229,6 +2300,8 @@ export interface PostClientCredentialRequestContent {
2229
2300
  parse_expiry_from_cert?: boolean;
2230
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. */
2231
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;
2232
2305
  }
2233
2306
  /**
2234
2307
  * @example
@@ -2812,6 +2885,63 @@ export interface AssociateOrganizationClientGrantRequestContent {
2812
2885
  /** A Client Grant ID to add to the organization. */
2813
2886
  grant_id: string;
2814
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
+ }
2815
2945
  /**
2816
2946
  * @example
2817
2947
  * {
@@ -3080,14 +3210,15 @@ export interface BulkUpdateAculRequestContent {
3080
3210
  * {}
3081
3211
  */
3082
3212
  export interface UpdateAculRequestContent {
3213
+ /** Rendering mode */
3083
3214
  rendering_mode?: Management.AculRenderingModeEnum;
3084
- context_configuration?: Management.AculContextConfiguration;
3215
+ context_configuration?: (Management.AculContextConfiguration | undefined) | null;
3085
3216
  /** Override Universal Login default head tags */
3086
3217
  default_head_tags_disabled?: boolean | null;
3087
3218
  /** Use page template with ACUL */
3088
3219
  use_page_template?: boolean | null;
3089
3220
  /** An array of head tags */
3090
- head_tags?: Management.AculHeadTag[];
3221
+ head_tags?: Management.AculHeadTag[] | null;
3091
3222
  filters?: Management.AculFilters | null;
3092
3223
  }
3093
3224
  /**
@@ -3213,6 +3344,7 @@ export interface GetTenantSettingsRequestParameters {
3213
3344
  */
3214
3345
  export interface UpdateTenantSettingsRequestContent {
3215
3346
  change_password?: Management.TenantSettingsPasswordPage | null;
3347
+ /** Device Flow configuration. */
3216
3348
  device_flow?: Management.TenantSettingsDeviceFlow | null;
3217
3349
  guardian_mfa_page?: Management.TenantSettingsGuardianPage | null;
3218
3350
  /** Default audience for API Authorization. */
@@ -3256,7 +3388,7 @@ export interface UpdateTenantSettingsRequestContent {
3256
3388
  /** Whether to accept an organization name instead of an ID on auth endpoints */
3257
3389
  allow_organization_name_in_authentication_api?: boolean | null;
3258
3390
  /** Supported ACR values */
3259
- acr_values_supported?: string[];
3391
+ acr_values_supported?: string[] | null;
3260
3392
  mtls?: Management.TenantSettingsMtls | null;
3261
3393
  /** Enables the use of Pushed Authorization Requests */
3262
3394
  pushed_authorization_requests_supported?: boolean | null;
@@ -3321,6 +3453,7 @@ export interface CreateUserAuthenticationMethodRequestContent {
3321
3453
  export interface UpdateUserAuthenticationMethodRequestContent {
3322
3454
  /** A human-readable label to identify the authentication method. */
3323
3455
  name?: string;
3456
+ /** Preferred phone authentication method */
3324
3457
  preferred_authentication_method?: Management.PreferredAuthenticationMethodEnum;
3325
3458
  }
3326
3459
  /**
@@ -3360,6 +3493,7 @@ export interface GetUserGroupsRequestParameters {
3360
3493
  * {}
3361
3494
  */
3362
3495
  export interface LinkUserIdentityRequestContent {
3496
+ /** Identity provider of the secondary user account being linked. */
3363
3497
  provider?: Management.UserIdentityProviderEnum;
3364
3498
  /** connection_id of the secondary user account being linked when more than one `auth0` database provider exists. */
3365
3499
  connection_id?: string;
@@ -35,7 +35,7 @@ export declare class ActionsClient {
35
35
  *
36
36
  * @example
37
37
  * await client.actions.list({
38
- * triggerId: "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: "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: "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: "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("triggerId", {
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("triggerId")
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("triggerId", {
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("triggerId")
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));
@@ -49,7 +49,6 @@ export declare class ClientGrantsClient {
49
49
  *
50
50
  * @example
51
51
  * await client.clientGrants.create({
52
- * client_id: "client_id",
53
52
  * audience: "audience"
54
53
  * })
55
54
  */
@@ -121,7 +121,6 @@ export class ClientGrantsClient {
121
121
  *
122
122
  * @example
123
123
  * await client.clientGrants.create({
124
- * client_id: "client_id",
125
124
  * audience: "audience"
126
125
  * })
127
126
  */
@@ -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>.