auth0 4.23.1 → 4.25.0

package/dist/cjs/management/__generated/models/index.d.ts

@@ -215,6 +215,14 @@ export interface Client {
      *
      */
     compliance_level: ClientComplianceLevelEnum;
+    /**
+     * Specifies how long, in seconds, a Pushed Authorization Request URI remains valid
+     *
+     */
+    par_request_expiry: number | null;
+    /**
+     */
+    token_quota: TokenQuota;
 }
 export declare const ClientTokenEndpointAuthMethodEnum: {
     readonly none: "none";
@@ -1075,6 +1083,9 @@ export interface ClientCreate {
     /**
      */
     refresh_token?: ClientRefreshToken | null;
+    /**
+     */
+    default_organization?: ClientCreateDefaultOrganization;
     /**
      * Defines how to proceed during an authentication transaction with regards an organization. Can be `deny` (default), `allow` or `require`.
      *
@@ -1106,6 +1117,14 @@ export interface ClientCreate {
      *
      */
     compliance_level?: ClientCreateComplianceLevelEnum;
+    /**
+     * Specifies how long, in seconds, a Pushed Authorization Request URI remains valid
+     *
+     */
+    par_request_expiry?: number | null;
+    /**
+     */
+    token_quota?: CreateTokenQuota;
 }
 export declare const ClientCreateTokenEndpointAuthMethodEnum: {
     readonly none: "none";
@@ -1879,6 +1898,25 @@ export declare const ClientCreateClientAuthenticationMethodsTlsClientAuthCredent
     readonly cert_subject_dn: "cert_subject_dn";
 };
 export type ClientCreateClientAuthenticationMethodsTlsClientAuthCredentialsInnerCredentialTypeEnum = (typeof ClientCreateClientAuthenticationMethodsTlsClientAuthCredentialsInnerCredentialTypeEnum)[keyof typeof ClientCreateClientAuthenticationMethodsTlsClientAuthCredentialsInnerCredentialTypeEnum];
+/**
+ * Defines the default Organization ID and flows
+ */
+export interface ClientCreateDefaultOrganization {
+    /**
+     * The default Organization ID to be used
+     *
+     */
+    organization_id: string;
+    /**
+     * The default Organization usage
+     *
+     */
+    flows: Array<ClientCreateDefaultOrganizationFlowsEnum>;
+}
+export declare const ClientCreateDefaultOrganizationFlowsEnum: {
+    readonly client_credentials: "client_credentials";
+};
+export type ClientCreateDefaultOrganizationFlowsEnum = (typeof ClientCreateDefaultOrganizationFlowsEnum)[keyof typeof ClientCreateDefaultOrganizationFlowsEnum];
 /**
  * Encryption used for WsFed responses with this client.
  */
@@ -2487,6 +2525,9 @@ export interface ClientUpdate {
     /**
      */
     custom_login_page_preview?: string;
+    /**
+     */
+    token_quota?: UpdateTokenQuota | null;
     /**
      * Form template for WS-Federation protocol
      *
@@ -2984,7 +3025,7 @@ export interface Connection {
      */
     realms: Array<string>;
     /**
-     * The ids of the clients for which the connection is enabled
+     * DEPRECATED property. Use the GET /connections/:id/clients endpoint to get the ids of the clients for which the connection is enabled
      *
      */
     enabled_clients: Array<string>;
@@ -3029,7 +3070,7 @@ export interface ConnectionCreate {
      */
     options?: ConnectionCreateOptions;
     /**
-     * The identifiers of the clients for which the connection is to be enabled. If the array is empty or the property is not specified, no clients are enabled
+     * DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.
      *
      */
     enabled_clients?: Array<string>;
@@ -3467,7 +3508,7 @@ export interface ConnectionUpdate {
      */
     options?: ConnectionUpdateOptions | null;
     /**
-     * The identifiers of the clients for which the connection is to be enabled. If the property is not specified, no clients are enabled. If the array is empty, the connection will be disabled for every client.
+     * DEPRECATED property. Use the PATCH /v2/connections/{id}/clients endpoint to enable or disable the connection for any clients.
      *
      */
     enabled_clients?: Array<string>;
@@ -3640,6 +3681,14 @@ export interface CreatePhoneProviderRequestCredentialsAnyOf {
      */
     auth_token: string;
 }
+/**
+ *
+ */
+export interface CreateTokenQuota {
+    /**
+     */
+    client_credentials: TokenQuotaClientCredentials;
+}
 /**
  *
  */
@@ -3700,6 +3749,17 @@ export declare const CustomDomainTypeEnum: {
     readonly self_managed_certs: "self_managed_certs";
 };
 export type CustomDomainTypeEnum = (typeof CustomDomainTypeEnum)[keyof typeof CustomDomainTypeEnum];
+/**
+ * Token Quota configuration, to configure quotas for token issuance for clients and organizations. Applied to all clients and organizations unless overridden in individual client or organization settings.
+ */
+export interface DefaultTokenQuota {
+    /**
+     */
+    clients?: TokenQuotaConfiguration;
+    /**
+     */
+    organizations?: TokenQuotaConfiguration;
+}
 /**
  *
  */
@@ -5354,6 +5414,33 @@ export interface GetClients200ResponseOneOf1 {
      */
     clients: Array<Client>;
 }
+/**
+ *
+ */
+export interface GetConnectionClients200Response {
+    [key: string]: any | any;
+    /**
+     * Clients for which the connection is enabled
+     *
+     */
+    clients: Array<GetConnectionClients200ResponseClientsInner>;
+    /**
+     * Encoded next token
+     *
+     */
+    next?: string;
+}
+/**
+ *
+ */
+export interface GetConnectionClients200ResponseClientsInner {
+    [key: string]: any | any;
+    /**
+     * The client id
+     *
+     */
+    client_id: string;
+}
 /**
  *
  */
@@ -7363,7 +7450,7 @@ export interface GetOrganizations200ResponseOneOf1 {
 export interface GetOrganizations200ResponseOneOfInner {
     [key: string]: any | any;
     /**
-     * Organization identifier
+     * Organization identifier.
      *
      */
     id: string;
@@ -7381,19 +7468,22 @@ export interface GetOrganizations200ResponseOneOfInner {
      */
     branding: GetOrganizations200ResponseOneOfInnerBranding;
     /**
-     * Metadata associated with the organization, in the form of an object with string values (max 255 chars).  Maximum of 10 metadata properties allowed.
+     * Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
      *
      */
     metadata: {
         [key: string]: any;
     };
+    /**
+     */
+    token_quota: TokenQuota;
 }
 /**
- * Theme defines how to style the login pages
+ * Theme defines how to style the login pages.
  */
 export interface GetOrganizations200ResponseOneOfInnerBranding {
     /**
-     * URL of logo to display on login page
+     * URL of logo to display on login page.
      *
      */
     logo_url: string;
@@ -7402,16 +7492,16 @@ export interface GetOrganizations200ResponseOneOfInnerBranding {
     colors: GetOrganizations200ResponseOneOfInnerBrandingColors;
 }
 /**
- * Color scheme used to customize the login pages
+ * Color scheme used to customize the login pages.
  */
 export interface GetOrganizations200ResponseOneOfInnerBrandingColors {
     /**
-     * HEX Color for primary elements
+     * HEX Color for primary elements.
      *
      */
     primary: string;
     /**
-     * HEX Color for background
+     * HEX Color for background.
      *
      */
     page_background: string;
@@ -9370,6 +9460,21 @@ export declare const PatchClientGrantsByIdRequestOrganizationUsageEnum: {
     readonly null: "null";
 };
 export type PatchClientGrantsByIdRequestOrganizationUsageEnum = (typeof PatchClientGrantsByIdRequestOrganizationUsageEnum)[keyof typeof PatchClientGrantsByIdRequestOrganizationUsageEnum];
+/**
+ *
+ */
+export interface PatchClientsRequestInner {
+    /**
+     * The client_id of the client to be the subject to change status
+     *
+     */
+    client_id: string;
+    /**
+     * Whether the connection is enabled or not for this client_id
+     *
+     */
+    status: boolean;
+}
 /**
  *
  */
@@ -9690,19 +9795,22 @@ export interface PatchOrganizationsByIdRequest {
      */
     branding?: PatchOrganizationsByIdRequestBranding | null;
     /**
-     * Metadata associated with the organization, in the form of an object with string values (max 255 chars).  Maximum of 10 metadata properties allowed.
+     * Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
      *
      */
     metadata?: {
         [key: string]: any;
     } | null;
+    /**
+     */
+    token_quota?: UpdateTokenQuota | null;
 }
 /**
- * Theme defines how to style the login pages
+ * Theme defines how to style the login pages.
  */
 export interface PatchOrganizationsByIdRequestBranding {
     /**
-     * URL of logo to display on login page
+     * URL of logo to display on login page.
      *
      */
     logo_url?: string;
@@ -13345,7 +13453,7 @@ export interface PostOrganizationMemberRolesRequest {
 export interface PostOrganizations201Response {
     [key: string]: any | any;
     /**
-     * Organization identifier
+     * Organization identifier.
      *
      */
     id: string;
@@ -13363,12 +13471,15 @@ export interface PostOrganizations201Response {
      */
     branding: GetOrganizations200ResponseOneOfInnerBranding;
     /**
-     * Metadata associated with the organization, in the form of an object with string values (max 255 chars).  Maximum of 10 metadata properties allowed.
+     * Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
      *
      */
     metadata: {
         [key: string]: any;
     };
+    /**
+     */
+    token_quota: TokenQuota;
     /**
      */
     enabled_connections: Array<PostOrganizations201ResponseEnabledConnectionsInner>;
@@ -13436,7 +13547,7 @@ export interface PostOrganizationsRequest {
      */
     branding?: PostOrganizationsRequestBranding;
     /**
-     * Metadata associated with the organization, in the form of an object with string values (max 255 chars).  Maximum of 10 metadata properties allowed.
+     * Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
      *
      */
     metadata?: {
@@ -13447,13 +13558,16 @@ export interface PostOrganizationsRequest {
      *
      */
     enabled_connections?: Array<PostOrganizationsRequestEnabledConnectionsInner>;
+    /**
+     */
+    token_quota?: CreateTokenQuota;
 }
 /**
- * Theme defines how to style the login pages
+ * Theme defines how to style the login pages.
  */
 export interface PostOrganizationsRequestBranding {
     /**
-     * URL of logo to display on login page
+     * URL of logo to display on login page.
      *
      */
     logo_url?: string;
@@ -15415,6 +15529,9 @@ export interface TenantSettings {
     /**
      */
     device_flow: TenantSettingsDeviceFlow | null;
+    /**
+     */
+    default_token_quota: DefaultTokenQuota | null;
     /**
      */
     flags: TenantSettingsFlags;
@@ -15458,6 +15575,11 @@ export interface TenantSettings {
      *
      */
     sandbox_version: string;
+    /**
+     * Selected sandbox version for rules and hooks extensibility.
+     *
+     */
+    legacy_sandbox_version: string;
     /**
      * Available sandbox versions for the extensibility environment.
      *
@@ -15479,6 +15601,9 @@ export interface TenantSettings {
     /**
      */
     sessions: TenantSettingsSessions | null;
+    /**
+     */
+    oidc_logout: TenantSettingsOidcLogout;
     /**
      * Whether to accept an organization name instead of an ID on auth endpoints
      *
@@ -15502,41 +15627,69 @@ export interface TenantSettings {
      *
      */
     pushed_authorization_requests_supported: boolean;
+    /**
+     * Supports iss parameter in authorization responses
+     *
+     */
+    authorization_response_iss_parameter_supported: boolean | null;
 }
 export declare const TenantSettingsEnabledLocalesEnum: {
+    readonly am: "am";
     readonly ar: "ar";
+    readonly ar_EG: "ar-EG";
+    readonly ar_SA: "ar-SA";
+    readonly az: "az";
     readonly bg: "bg";
+    readonly bn: "bn";
     readonly bs: "bs";
     readonly ca_ES: "ca-ES";
+    readonly cnr: "cnr";
     readonly cs: "cs";
     readonly cy: "cy";
     readonly da: "da";
     readonly de: "de";
     readonly el: "el";
     readonly en: "en";
+    readonly en_CA: "en-CA";
     readonly es: "es";
+    readonly es_419: "es-419";
+    readonly es_AR: "es-AR";
+    readonly es_MX: "es-MX";
     readonly et: "et";
     readonly eu_ES: "eu-ES";
+    readonly fa: "fa";
     readonly fi: "fi";
     readonly fr: "fr";
     readonly fr_CA: "fr-CA";
     readonly fr_FR: "fr-FR";
     readonly gl_ES: "gl-ES";
+    readonly gu: "gu";
     readonly he: "he";
     readonly hi: "hi";
     readonly hr: "hr";
     readonly hu: "hu";
+    readonly hy: "hy";
     readonly id: "id";
     readonly is: "is";
     readonly it: "it";
     readonly ja: "ja";
+    readonly ka: "ka";
+    readonly kk: "kk";
+    readonly kn: "kn";
     readonly ko: "ko";
     readonly lt: "lt";
     readonly lv: "lv";
+    readonly mk: "mk";
+    readonly ml: "ml";
+    readonly mn: "mn";
+    readonly mr: "mr";
+    readonly ms: "ms";
+    readonly my: "my";
     readonly nb: "nb";
     readonly nl: "nl";
     readonly nn: "nn";
     readonly no: "no";
+    readonly pa: "pa";
     readonly pl: "pl";
     readonly pt: "pt";
     readonly pt_BR: "pt-BR";
@@ -15545,13 +15698,22 @@ export declare const TenantSettingsEnabledLocalesEnum: {
     readonly ru: "ru";
     readonly sk: "sk";
     readonly sl: "sl";
+    readonly so: "so";
+    readonly sq: "sq";
     readonly sr: "sr";
     readonly sv: "sv";
+    readonly sw: "sw";
+    readonly ta: "ta";
+    readonly te: "te";
     readonly th: "th";
+    readonly tl: "tl";
     readonly tr: "tr";
     readonly uk: "uk";
+    readonly ur: "ur";
     readonly vi: "vi";
+    readonly zgh: "zgh";
     readonly zh_CN: "zh-CN";
+    readonly zh_HK: "zh-HK";
     readonly zh_TW: "zh-TW";
 };
 export type TenantSettingsEnabledLocalesEnum = (typeof TenantSettingsEnabledLocalesEnum)[keyof typeof TenantSettingsEnabledLocalesEnum];
@@ -15729,6 +15891,36 @@ export interface TenantSettingsFlags {
      *
      */
     remove_alg_from_jwks: boolean;
+    /**
+     * Improves bot detection during signup in classic universal login
+     *
+     */
+    improved_signup_bot_detection_in_classic: boolean;
+    /**
+     * This tenant signed up for the Auth4GenAI trail
+     *
+     */
+    genai_trial: boolean;
+    /**
+     * Whether third-party developers can <a href="https://auth0.com/docs/api-auth/dynamic-client-registration">dynamically register</a> applications for your APIs (true) or not (false). This flag enables dynamic client registration.
+     *
+     */
+    enable_dynamic_client_registration: boolean;
+    /**
+     * If true, SMS phone numbers will not be obfuscated in Management API GET calls.
+     *
+     */
+    disable_management_api_sms_obfuscation: boolean;
+    /**
+     * Changes email_verified behavior for Azure AD/ADFS connections when enabled. Sets email_verified to false otherwise.
+     *
+     */
+    trust_azure_adfs_email_verified_connection_property: boolean;
+    /**
+     * If true, custom domains feature will be enabled for tenant.
+     *
+     */
+    custom_domains_provisioning: boolean;
 }
 /**
  * Guardian page customization.
@@ -15755,6 +15947,16 @@ export interface TenantSettingsMtls {
      */
     enable_endpoint_aliases: boolean;
 }
+/**
+ * Settings related to OIDC RP-initiated Logout
+ */
+export interface TenantSettingsOidcLogout {
+    /**
+     * Enable the end_session_endpoint URL in the .well-known discovery configuration
+     *
+     */
+    rp_logout_end_session_endpoint_discovery: boolean;
+}
 /**
  * Session cookie configuration
  */
@@ -15806,6 +16008,9 @@ export interface TenantSettingsUpdate {
     /**
      */
     error_page?: TenantSettingsUpdateErrorPage | null;
+    /**
+     */
+    default_token_quota?: DefaultTokenQuota | null;
     /**
      */
     flags?: TenantSettingsUpdateFlags;
@@ -15849,6 +16054,11 @@ export interface TenantSettingsUpdate {
      *
      */
     sandbox_version?: string;
+    /**
+     * Selected legacy sandbox version for the extensibility environment
+     *
+     */
+    legacy_sandbox_version?: string;
     /**
      * The default absolute redirection uri, must be https
      *
@@ -15865,6 +16075,9 @@ export interface TenantSettingsUpdate {
     /**
      */
     sessions?: TenantSettingsUpdateSessions | null;
+    /**
+     */
+    oidc_logout?: TenantSettingsUpdateOidcLogout;
     /**
      * Whether to enable flexible factors for MFA in the PostLogin action
      *
@@ -15888,41 +16101,69 @@ export interface TenantSettingsUpdate {
      *
      */
     pushed_authorization_requests_supported?: boolean | null;
+    /**
+     * Supports iss parameter in authorization responses
+     *
+     */
+    authorization_response_iss_parameter_supported?: boolean | null;
 }
 export declare const TenantSettingsUpdateEnabledLocalesEnum: {
+    readonly am: "am";
     readonly ar: "ar";
+    readonly ar_EG: "ar-EG";
+    readonly ar_SA: "ar-SA";
+    readonly az: "az";
     readonly bg: "bg";
+    readonly bn: "bn";
     readonly bs: "bs";
     readonly ca_ES: "ca-ES";
+    readonly cnr: "cnr";
     readonly cs: "cs";
     readonly cy: "cy";
     readonly da: "da";
     readonly de: "de";
     readonly el: "el";
     readonly en: "en";
+    readonly en_CA: "en-CA";
     readonly es: "es";
+    readonly es_419: "es-419";
+    readonly es_AR: "es-AR";
+    readonly es_MX: "es-MX";
     readonly et: "et";
     readonly eu_ES: "eu-ES";
+    readonly fa: "fa";
     readonly fi: "fi";
     readonly fr: "fr";
     readonly fr_CA: "fr-CA";
     readonly fr_FR: "fr-FR";
     readonly gl_ES: "gl-ES";
+    readonly gu: "gu";
     readonly he: "he";
     readonly hi: "hi";
     readonly hr: "hr";
     readonly hu: "hu";
+    readonly hy: "hy";
     readonly id: "id";
     readonly is: "is";
     readonly it: "it";
     readonly ja: "ja";
+    readonly ka: "ka";
+    readonly kk: "kk";
+    readonly kn: "kn";
     readonly ko: "ko";
     readonly lt: "lt";
     readonly lv: "lv";
+    readonly mk: "mk";
+    readonly ml: "ml";
+    readonly mn: "mn";
+    readonly mr: "mr";
+    readonly ms: "ms";
+    readonly my: "my";
     readonly nb: "nb";
     readonly nl: "nl";
     readonly nn: "nn";
     readonly no: "no";
+    readonly pa: "pa";
     readonly pl: "pl";
     readonly pt: "pt";
     readonly pt_BR: "pt-BR";
@@ -15931,13 +16172,22 @@ export declare const TenantSettingsUpdateEnabledLocalesEnum: {
     readonly ru: "ru";
     readonly sk: "sk";
     readonly sl: "sl";
+    readonly so: "so";
+    readonly sq: "sq";
     readonly sr: "sr";
     readonly sv: "sv";
+    readonly sw: "sw";
+    readonly ta: "ta";
+    readonly te: "te";
     readonly th: "th";
+    readonly tl: "tl";
     readonly tr: "tr";
     readonly uk: "uk";
+    readonly ur: "ur";
     readonly vi: "vi";
+    readonly zgh: "zgh";
     readonly zh_CN: "zh-CN";
+    readonly zh_HK: "zh-HK";
     readonly zh_TW: "zh-TW";
 };
 export type TenantSettingsUpdateEnabledLocalesEnum = (typeof TenantSettingsUpdateEnabledLocalesEnum)[keyof typeof TenantSettingsUpdateEnabledLocalesEnum];
@@ -16120,11 +16370,21 @@ export interface TenantSettingsUpdateFlags {
      *
      */
     mfa_show_factor_list_on_enrollment?: boolean;
+    /**
+     * Require the use of JWT Secured Authorization Requests (JAR)
+     *
+     */
+    require_signed_request_object?: boolean;
     /**
      * Removes alg property from jwks .well-known endpoint
      *
      */
     remove_alg_from_jwks?: boolean;
+    /**
+     * Improves bot detection during signup in classic universal login
+     *
+     */
+    improved_signup_bot_detection_in_classic?: boolean;
 }
 export declare const TenantSettingsUpdateFlagsChangePwdFlowV1Enum: {
     readonly false: false;
@@ -16155,6 +16415,16 @@ export interface TenantSettingsUpdateMtls {
      */
     enable_endpoint_aliases?: boolean;
 }
+/**
+ * Settings related to OIDC RP-initiated Logout
+ */
+export interface TenantSettingsUpdateOidcLogout {
+    /**
+     * Enable the end_session_endpoint URL in the .well-known discovery configuration
+     *
+     */
+    rp_logout_end_session_endpoint_discovery?: boolean;
+}
 /**
  * Sessions related settings for tenant
  */
@@ -16180,6 +16450,43 @@ export interface Token {
      */
     jti: string;
 }
+/**
+ *
+ */
+export interface TokenQuota {
+    /**
+     */
+    client_credentials: TokenQuotaClientCredentials;
+}
+/**
+ * The token quota configuration
+ */
+export interface TokenQuotaClientCredentials {
+    /**
+     * If enabled, the quota will be enforced and requests in excess of the quota will fail. If disabled, the quota will not be enforced, but notifications for requests exceeding the quota will be available in logs.
+     *
+     */
+    enforce?: boolean;
+    /**
+     * Maximum number of issued tokens per day
+     *
+     */
+    per_day?: number;
+    /**
+     * Maximum number of issued tokens per hour
+     *
+     */
+    per_hour?: number;
+}
+/**
+ *
+ */
+export interface TokenQuotaConfiguration {
+    [key: string]: any | any;
+    /**
+     */
+    client_credentials: TokenQuotaClientCredentials;
+}
 /**
  *
  */
@@ -16231,6 +16538,14 @@ export declare const UpdatePhoneProviderRequestNameEnum: {
     readonly custom: "custom";
 };
 export type UpdatePhoneProviderRequestNameEnum = (typeof UpdatePhoneProviderRequestNameEnum)[keyof typeof UpdatePhoneProviderRequestNameEnum];
+/**
+ *
+ */
+export interface UpdateTokenQuota {
+    /**
+     */
+    client_credentials: TokenQuotaClientCredentials;
+}
 /**
  *
  */
@@ -17241,6 +17556,26 @@ export interface DeleteUsersByEmailRequest {
      */
     email: string;
 }
+/**
+ *
+ */
+export interface GetConnectionClientsRequest {
+    /**
+     * The id of the connection for which enabled clients are to be retrieved
+     *
+     */
+    id: string;
+    /**
+     * Number of results per page. Defaults to 50.
+     *
+     */
+    take?: number;
+    /**
+     * Optional Id from which to start selection.
+     *
+     */
+    from?: string;
+}
 /**
  *
  */
@@ -17343,6 +17678,11 @@ export interface GetConnectionsRequest {
      *
      */
     strategy?: Array<GetConnectionsStrategyEnum>;
+    /**
+     * Provide the domain_alias to only retrieve connections with such domain
+     *
+     */
+    domain_alias?: string;
     /**
      * Provide the name of the connection to retrieve
      *
@@ -17419,6 +17759,16 @@ export interface GetStatusRequest {
      */
     id: string;
 }
+/**
+ *
+ */
+export interface PatchClientsRequest {
+    /**
+     * The id of the connection to modify
+     *
+     */
+    id: string;
+}
 /**
  *
  */