authhero 5.8.0 → 5.9.0

package/dist/types/routes/management-api/tenants.d.ts

@@ -0,0 +1,546 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import { Bindings, Variables } from "../../types";
+export declare const tenantRoutes: OpenAPIHono<{
+    Bindings: Bindings;
+    Variables: Variables;
+}, {
+    "/settings": {
+        $get: {
+            input: {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                created_at: string;
+                updated_at: string;
+                audience: string;
+                friendly_name: string;
+                sender_email: string;
+                sender_name: string;
+                id: string;
+                picture_url?: string | undefined;
+                support_email?: string | undefined;
+                support_url?: string | undefined;
+                session_lifetime?: number | undefined;
+                idle_session_lifetime?: number | undefined;
+                ephemeral_session_lifetime?: number | undefined;
+                idle_ephemeral_session_lifetime?: number | undefined;
+                session_cookie?: {
+                    mode?: "persistent" | "non-persistent" | undefined;
+                } | undefined;
+                allowed_logout_urls?: string[] | undefined;
+                default_redirection_uri?: string | undefined;
+                default_client_id?: string | undefined;
+                enabled_locales?: string[] | undefined;
+                default_directory?: string | undefined;
+                error_page?: {
+                    html?: string | undefined;
+                    show_log_link?: boolean | undefined;
+                    url?: string | undefined;
+                } | null | undefined;
+                flags?: {
+                    allow_changing_enable_sso?: boolean | undefined;
+                    allow_legacy_delegation_grant_types?: boolean | undefined;
+                    allow_legacy_ro_grant_types?: boolean | undefined;
+                    allow_legacy_tokeninfo_endpoint?: boolean | undefined;
+                    change_pwd_flow_v1?: boolean | undefined;
+                    custom_domains_provisioning?: boolean | undefined;
+                    dashboard_insights_view?: boolean | undefined;
+                    dashboard_log_streams_next?: boolean | undefined;
+                    disable_clickjack_protection_headers?: boolean | undefined;
+                    disable_fields_map_fix?: boolean | undefined;
+                    disable_impersonation?: boolean | undefined;
+                    disable_management_api_sms_obfuscation?: boolean | undefined;
+                    enable_adfs_waad_email_verification?: boolean | undefined;
+                    enable_apis_section?: boolean | undefined;
+                    enable_client_connections?: boolean | undefined;
+                    enable_custom_domain_in_emails?: boolean | undefined;
+                    enable_dynamic_client_registration?: boolean | undefined;
+                    dcr_require_initial_access_token?: boolean | undefined;
+                    dcr_allowed_grant_types?: string[] | undefined;
+                    allow_http_return_to?: string[] | undefined;
+                    enable_idtoken_api2?: boolean | undefined;
+                    enable_legacy_logs_search_v2?: boolean | undefined;
+                    enable_legacy_profile?: boolean | undefined;
+                    enable_pipeline2?: boolean | undefined;
+                    enable_public_signup_user_exists_error?: boolean | undefined;
+                    enable_sso?: boolean | undefined;
+                    enforce_client_authentication_on_passwordless_start?: boolean | undefined;
+                    genai_trial?: boolean | undefined;
+                    improved_signup_bot_detection_in_classic?: boolean | undefined;
+                    mfa_show_factor_list_on_enrollment?: boolean | undefined;
+                    no_disclose_enterprise_connections?: boolean | undefined;
+                    remove_alg_from_jwks?: boolean | undefined;
+                    revoke_refresh_token_grant?: boolean | undefined;
+                    trust_azure_adfs_email_verified_connection_property?: boolean | undefined;
+                    use_scope_descriptions_for_consent?: boolean | undefined;
+                    inherit_global_permissions_in_organizations?: boolean | undefined;
+                } | undefined;
+                sandbox_version?: string | undefined;
+                legacy_sandbox_version?: string | undefined;
+                sandbox_versions_available?: string[] | undefined;
+                change_password?: {
+                    enabled?: boolean | undefined;
+                    html?: string | undefined;
+                } | undefined;
+                guardian_mfa_page?: {
+                    enabled?: boolean | undefined;
+                    html?: string | undefined;
+                } | undefined;
+                device_flow?: {
+                    charset?: "base20" | "digits" | undefined;
+                    mask?: string | undefined;
+                } | undefined;
+                default_token_quota?: {
+                    clients?: {
+                        client_credentials?: {
+                            [x: string]: any;
+                        } | undefined;
+                    } | undefined;
+                    organizations?: {
+                        client_credentials?: {
+                            [x: string]: any;
+                        } | undefined;
+                    } | undefined;
+                } | null | undefined;
+                default_audience?: string | undefined;
+                default_organization?: string | undefined;
+                sessions?: {
+                    oidc_logout_prompt_enabled?: boolean | undefined;
+                } | undefined;
+                oidc_logout?: {
+                    rp_logout_end_session_endpoint_discovery?: boolean | undefined;
+                } | undefined;
+                allow_organization_name_in_authentication_api?: boolean | undefined;
+                customize_mfa_in_postlogin_action?: boolean | undefined;
+                acr_values_supported?: string[] | undefined;
+                mtls?: {
+                    enable_endpoint_aliases?: boolean | undefined;
+                } | null | undefined;
+                pushed_authorization_requests_supported?: boolean | undefined;
+                authorization_response_iss_parameter_supported?: boolean | undefined;
+                attack_protection?: {
+                    breached_password_detection?: {
+                        enabled?: boolean | undefined;
+                        shields?: string[] | undefined;
+                        admin_notification_frequency?: string[] | undefined;
+                        method?: string | undefined;
+                        stage?: {
+                            "pre-user-registration"?: {
+                                shields?: string[] | undefined;
+                            } | undefined;
+                            "pre-change-password"?: {
+                                shields?: string[] | undefined;
+                            } | undefined;
+                        } | undefined;
+                    } | undefined;
+                    brute_force_protection?: {
+                        enabled?: boolean | undefined;
+                        shields?: string[] | undefined;
+                        allowlist?: string[] | undefined;
+                        mode?: string | undefined;
+                        max_attempts?: number | undefined;
+                    } | undefined;
+                    suspicious_ip_throttling?: {
+                        enabled?: boolean | undefined;
+                        shields?: string[] | undefined;
+                        allowlist?: string[] | undefined;
+                        stage?: {
+                            "pre-login"?: {
+                                max_attempts?: number | undefined;
+                                rate?: number | undefined;
+                            } | undefined;
+                            "pre-user-registration"?: {
+                                max_attempts?: number | undefined;
+                                rate?: number | undefined;
+                            } | undefined;
+                        } | undefined;
+                    } | undefined;
+                } | undefined;
+                mfa?: {
+                    policy?: "never" | "always" | undefined;
+                    factors?: {
+                        sms: boolean;
+                        otp: boolean;
+                        email: boolean;
+                        push_notification: boolean;
+                        webauthn_roaming: boolean;
+                        webauthn_platform: boolean;
+                        recovery_code: boolean;
+                        duo: boolean;
+                    } | undefined;
+                    sms_provider?: {
+                        provider?: "twilio" | "vonage" | "aws_sns" | "phone_message_hook" | undefined;
+                    } | undefined;
+                    twilio?: {
+                        sid?: string | undefined;
+                        auth_token?: string | undefined;
+                        from?: string | undefined;
+                        messaging_service_sid?: string | undefined;
+                    } | undefined;
+                    phone_message?: {
+                        message?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                is_control_plane?: boolean | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/settings": {
+        $patch: {
+            input: {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    id?: string | undefined;
+                    audience?: string | undefined;
+                    friendly_name?: string | undefined;
+                    picture_url?: string | undefined;
+                    support_email?: string | undefined;
+                    support_url?: string | undefined;
+                    sender_email?: string | undefined;
+                    sender_name?: string | undefined;
+                    session_lifetime?: number | undefined;
+                    idle_session_lifetime?: number | undefined;
+                    ephemeral_session_lifetime?: number | undefined;
+                    idle_ephemeral_session_lifetime?: number | undefined;
+                    session_cookie?: {
+                        mode?: "persistent" | "non-persistent" | undefined;
+                    } | undefined;
+                    allowed_logout_urls?: string[] | undefined;
+                    default_redirection_uri?: string | undefined;
+                    default_client_id?: string | undefined;
+                    enabled_locales?: string[] | undefined;
+                    default_directory?: string | undefined;
+                    error_page?: {
+                        html?: string | undefined;
+                        show_log_link?: boolean | undefined;
+                        url?: string | undefined;
+                    } | null | undefined;
+                    flags?: {
+                        allow_changing_enable_sso?: boolean | undefined;
+                        allow_legacy_delegation_grant_types?: boolean | undefined;
+                        allow_legacy_ro_grant_types?: boolean | undefined;
+                        allow_legacy_tokeninfo_endpoint?: boolean | undefined;
+                        change_pwd_flow_v1?: boolean | undefined;
+                        custom_domains_provisioning?: boolean | undefined;
+                        dashboard_insights_view?: boolean | undefined;
+                        dashboard_log_streams_next?: boolean | undefined;
+                        disable_clickjack_protection_headers?: boolean | undefined;
+                        disable_fields_map_fix?: boolean | undefined;
+                        disable_impersonation?: boolean | undefined;
+                        disable_management_api_sms_obfuscation?: boolean | undefined;
+                        enable_adfs_waad_email_verification?: boolean | undefined;
+                        enable_apis_section?: boolean | undefined;
+                        enable_client_connections?: boolean | undefined;
+                        enable_custom_domain_in_emails?: boolean | undefined;
+                        enable_dynamic_client_registration?: boolean | undefined;
+                        dcr_require_initial_access_token?: boolean | undefined;
+                        dcr_allowed_grant_types?: string[] | undefined;
+                        allow_http_return_to?: string[] | undefined;
+                        enable_idtoken_api2?: boolean | undefined;
+                        enable_legacy_logs_search_v2?: boolean | undefined;
+                        enable_legacy_profile?: boolean | undefined;
+                        enable_pipeline2?: boolean | undefined;
+                        enable_public_signup_user_exists_error?: boolean | undefined;
+                        enable_sso?: boolean | undefined;
+                        enforce_client_authentication_on_passwordless_start?: boolean | undefined;
+                        genai_trial?: boolean | undefined;
+                        improved_signup_bot_detection_in_classic?: boolean | undefined;
+                        mfa_show_factor_list_on_enrollment?: boolean | undefined;
+                        no_disclose_enterprise_connections?: boolean | undefined;
+                        remove_alg_from_jwks?: boolean | undefined;
+                        revoke_refresh_token_grant?: boolean | undefined;
+                        trust_azure_adfs_email_verified_connection_property?: boolean | undefined;
+                        use_scope_descriptions_for_consent?: boolean | undefined;
+                        inherit_global_permissions_in_organizations?: boolean | undefined;
+                    } | undefined;
+                    sandbox_version?: string | undefined;
+                    legacy_sandbox_version?: string | undefined;
+                    sandbox_versions_available?: string[] | undefined;
+                    change_password?: {
+                        enabled?: boolean | undefined;
+                        html?: string | undefined;
+                    } | undefined;
+                    guardian_mfa_page?: {
+                        enabled?: boolean | undefined;
+                        html?: string | undefined;
+                    } | undefined;
+                    device_flow?: {
+                        charset?: "base20" | "digits" | undefined;
+                        mask?: string | undefined;
+                    } | undefined;
+                    default_token_quota?: {
+                        clients?: {
+                            client_credentials?: Record<string, any> | undefined;
+                        } | undefined;
+                        organizations?: {
+                            client_credentials?: Record<string, any> | undefined;
+                        } | undefined;
+                    } | null | undefined;
+                    default_audience?: string | undefined;
+                    default_organization?: string | undefined;
+                    sessions?: {
+                        oidc_logout_prompt_enabled?: boolean | undefined;
+                    } | undefined;
+                    oidc_logout?: {
+                        rp_logout_end_session_endpoint_discovery?: boolean | undefined;
+                    } | undefined;
+                    allow_organization_name_in_authentication_api?: boolean | undefined;
+                    customize_mfa_in_postlogin_action?: boolean | undefined;
+                    acr_values_supported?: string[] | undefined;
+                    mtls?: {
+                        enable_endpoint_aliases?: boolean | undefined;
+                    } | null | undefined;
+                    pushed_authorization_requests_supported?: boolean | undefined;
+                    authorization_response_iss_parameter_supported?: boolean | undefined;
+                    attack_protection?: {
+                        breached_password_detection?: {
+                            enabled?: boolean | undefined;
+                            shields?: string[] | undefined;
+                            admin_notification_frequency?: string[] | undefined;
+                            method?: string | undefined;
+                            stage?: {
+                                "pre-user-registration"?: {
+                                    shields?: string[] | undefined;
+                                } | undefined;
+                                "pre-change-password"?: {
+                                    shields?: string[] | undefined;
+                                } | undefined;
+                            } | undefined;
+                        } | undefined;
+                        brute_force_protection?: {
+                            enabled?: boolean | undefined;
+                            shields?: string[] | undefined;
+                            allowlist?: string[] | undefined;
+                            mode?: string | undefined;
+                            max_attempts?: number | undefined;
+                        } | undefined;
+                        suspicious_ip_throttling?: {
+                            enabled?: boolean | undefined;
+                            shields?: string[] | undefined;
+                            allowlist?: string[] | undefined;
+                            stage?: {
+                                "pre-login"?: {
+                                    max_attempts?: number | undefined;
+                                    rate?: number | undefined;
+                                } | undefined;
+                                "pre-user-registration"?: {
+                                    max_attempts?: number | undefined;
+                                    rate?: number | undefined;
+                                } | undefined;
+                            } | undefined;
+                        } | undefined;
+                    } | undefined;
+                    mfa?: {
+                        policy?: "never" | "always" | undefined;
+                        factors?: {
+                            sms?: boolean | undefined;
+                            otp?: boolean | undefined;
+                            email?: boolean | undefined;
+                            push_notification?: boolean | undefined;
+                            webauthn_roaming?: boolean | undefined;
+                            webauthn_platform?: boolean | undefined;
+                            recovery_code?: boolean | undefined;
+                            duo?: boolean | undefined;
+                        } | undefined;
+                        sms_provider?: {
+                            provider?: "twilio" | "vonage" | "aws_sns" | "phone_message_hook" | undefined;
+                        } | undefined;
+                        twilio?: {
+                            sid?: string | undefined;
+                            auth_token?: string | undefined;
+                            from?: string | undefined;
+                            messaging_service_sid?: string | undefined;
+                        } | undefined;
+                        phone_message?: {
+                            message?: string | undefined;
+                        } | undefined;
+                    } | undefined;
+                };
+            };
+            output: {
+                created_at: string;
+                updated_at: string;
+                audience: string;
+                friendly_name: string;
+                sender_email: string;
+                sender_name: string;
+                id: string;
+                picture_url?: string | undefined;
+                support_email?: string | undefined;
+                support_url?: string | undefined;
+                session_lifetime?: number | undefined;
+                idle_session_lifetime?: number | undefined;
+                ephemeral_session_lifetime?: number | undefined;
+                idle_ephemeral_session_lifetime?: number | undefined;
+                session_cookie?: {
+                    mode?: "persistent" | "non-persistent" | undefined;
+                } | undefined;
+                allowed_logout_urls?: string[] | undefined;
+                default_redirection_uri?: string | undefined;
+                default_client_id?: string | undefined;
+                enabled_locales?: string[] | undefined;
+                default_directory?: string | undefined;
+                error_page?: {
+                    html?: string | undefined;
+                    show_log_link?: boolean | undefined;
+                    url?: string | undefined;
+                } | null | undefined;
+                flags?: {
+                    allow_changing_enable_sso?: boolean | undefined;
+                    allow_legacy_delegation_grant_types?: boolean | undefined;
+                    allow_legacy_ro_grant_types?: boolean | undefined;
+                    allow_legacy_tokeninfo_endpoint?: boolean | undefined;
+                    change_pwd_flow_v1?: boolean | undefined;
+                    custom_domains_provisioning?: boolean | undefined;
+                    dashboard_insights_view?: boolean | undefined;
+                    dashboard_log_streams_next?: boolean | undefined;
+                    disable_clickjack_protection_headers?: boolean | undefined;
+                    disable_fields_map_fix?: boolean | undefined;
+                    disable_impersonation?: boolean | undefined;
+                    disable_management_api_sms_obfuscation?: boolean | undefined;
+                    enable_adfs_waad_email_verification?: boolean | undefined;
+                    enable_apis_section?: boolean | undefined;
+                    enable_client_connections?: boolean | undefined;
+                    enable_custom_domain_in_emails?: boolean | undefined;
+                    enable_dynamic_client_registration?: boolean | undefined;
+                    dcr_require_initial_access_token?: boolean | undefined;
+                    dcr_allowed_grant_types?: string[] | undefined;
+                    allow_http_return_to?: string[] | undefined;
+                    enable_idtoken_api2?: boolean | undefined;
+                    enable_legacy_logs_search_v2?: boolean | undefined;
+                    enable_legacy_profile?: boolean | undefined;
+                    enable_pipeline2?: boolean | undefined;
+                    enable_public_signup_user_exists_error?: boolean | undefined;
+                    enable_sso?: boolean | undefined;
+                    enforce_client_authentication_on_passwordless_start?: boolean | undefined;
+                    genai_trial?: boolean | undefined;
+                    improved_signup_bot_detection_in_classic?: boolean | undefined;
+                    mfa_show_factor_list_on_enrollment?: boolean | undefined;
+                    no_disclose_enterprise_connections?: boolean | undefined;
+                    remove_alg_from_jwks?: boolean | undefined;
+                    revoke_refresh_token_grant?: boolean | undefined;
+                    trust_azure_adfs_email_verified_connection_property?: boolean | undefined;
+                    use_scope_descriptions_for_consent?: boolean | undefined;
+                    inherit_global_permissions_in_organizations?: boolean | undefined;
+                } | undefined;
+                sandbox_version?: string | undefined;
+                legacy_sandbox_version?: string | undefined;
+                sandbox_versions_available?: string[] | undefined;
+                change_password?: {
+                    enabled?: boolean | undefined;
+                    html?: string | undefined;
+                } | undefined;
+                guardian_mfa_page?: {
+                    enabled?: boolean | undefined;
+                    html?: string | undefined;
+                } | undefined;
+                device_flow?: {
+                    charset?: "base20" | "digits" | undefined;
+                    mask?: string | undefined;
+                } | undefined;
+                default_token_quota?: {
+                    clients?: {
+                        client_credentials?: {
+                            [x: string]: any;
+                        } | undefined;
+                    } | undefined;
+                    organizations?: {
+                        client_credentials?: {
+                            [x: string]: any;
+                        } | undefined;
+                    } | undefined;
+                } | null | undefined;
+                default_audience?: string | undefined;
+                default_organization?: string | undefined;
+                sessions?: {
+                    oidc_logout_prompt_enabled?: boolean | undefined;
+                } | undefined;
+                oidc_logout?: {
+                    rp_logout_end_session_endpoint_discovery?: boolean | undefined;
+                } | undefined;
+                allow_organization_name_in_authentication_api?: boolean | undefined;
+                customize_mfa_in_postlogin_action?: boolean | undefined;
+                acr_values_supported?: string[] | undefined;
+                mtls?: {
+                    enable_endpoint_aliases?: boolean | undefined;
+                } | null | undefined;
+                pushed_authorization_requests_supported?: boolean | undefined;
+                authorization_response_iss_parameter_supported?: boolean | undefined;
+                attack_protection?: {
+                    breached_password_detection?: {
+                        enabled?: boolean | undefined;
+                        shields?: string[] | undefined;
+                        admin_notification_frequency?: string[] | undefined;
+                        method?: string | undefined;
+                        stage?: {
+                            "pre-user-registration"?: {
+                                shields?: string[] | undefined;
+                            } | undefined;
+                            "pre-change-password"?: {
+                                shields?: string[] | undefined;
+                            } | undefined;
+                        } | undefined;
+                    } | undefined;
+                    brute_force_protection?: {
+                        enabled?: boolean | undefined;
+                        shields?: string[] | undefined;
+                        allowlist?: string[] | undefined;
+                        mode?: string | undefined;
+                        max_attempts?: number | undefined;
+                    } | undefined;
+                    suspicious_ip_throttling?: {
+                        enabled?: boolean | undefined;
+                        shields?: string[] | undefined;
+                        allowlist?: string[] | undefined;
+                        stage?: {
+                            "pre-login"?: {
+                                max_attempts?: number | undefined;
+                                rate?: number | undefined;
+                            } | undefined;
+                            "pre-user-registration"?: {
+                                max_attempts?: number | undefined;
+                                rate?: number | undefined;
+                            } | undefined;
+                        } | undefined;
+                    } | undefined;
+                } | undefined;
+                mfa?: {
+                    policy?: "never" | "always" | undefined;
+                    factors?: {
+                        sms: boolean;
+                        otp: boolean;
+                        email: boolean;
+                        push_notification: boolean;
+                        webauthn_roaming: boolean;
+                        webauthn_platform: boolean;
+                        recovery_code: boolean;
+                        duo: boolean;
+                    } | undefined;
+                    sms_provider?: {
+                        provider?: "twilio" | "vonage" | "aws_sns" | "phone_message_hook" | undefined;
+                    } | undefined;
+                    twilio?: {
+                        sid?: string | undefined;
+                        auth_token?: string | undefined;
+                        from?: string | undefined;
+                        messaging_service_sid?: string | undefined;
+                    } | undefined;
+                    phone_message?: {
+                        message?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                is_control_plane?: boolean | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+}, "/">;