BasicAuthSettingsForm() — supabase Function Reference

Source Code

apps/studio/components/interfaces/Auth/BasicAuthSettingsForm.tsx lines 52–349

export const BasicAuthSettingsForm = () => {
  const { ref: projectRef } = useParams()
  const showManualLinking = useIsFeatureEnabled('authentication:show_manual_linking')

  const {
    data: authConfig,
    error: authConfigError,
    isError,
    isSuccess,
    isPending: isLoading,
  } = useAuthConfigQuery({ projectRef })
  const { mutate: updateAuthConfig, isPending: isUpdatingConfig } = useAuthConfigUpdateMutation()

  const { can: canReadConfig, isSuccess: isPermissionsLoaded } = useAsyncCheckPermissions(
    PermissionAction.READ,
    'custom_config_gotrue'
  )
  const { can: canUpdateConfig } = useAsyncCheckPermissions(
    PermissionAction.UPDATE,
    'custom_config_gotrue'
  )

  const form = useForm({
    resolver: yupResolver(schema),
    defaultValues: {
      DISABLE_SIGNUP: true,
      EXTERNAL_ANONYMOUS_USERS_ENABLED: false,
      SECURITY_MANUAL_LINKING_ENABLED: false,
      MAILER_AUTOCONFIRM: true,
      SITE_URL: '',
    },
  })

  useEffect(() => {
    if (authConfig) {
      form.reset({
        DISABLE_SIGNUP: !authConfig.DISABLE_SIGNUP,
        EXTERNAL_ANONYMOUS_USERS_ENABLED: authConfig.EXTERNAL_ANONYMOUS_USERS_ENABLED,
        SECURITY_MANUAL_LINKING_ENABLED: authConfig.SECURITY_MANUAL_LINKING_ENABLED,
        // The backend uses false to represent that email confirmation is required
        MAILER_AUTOCONFIRM: !authConfig.MAILER_AUTOCONFIRM,
        SITE_URL: authConfig.SITE_URL,
      })
    }
  }, [authConfig])

  const onSubmit = (values: any) => {
    const payload = { ...values }
    payload.DISABLE_SIGNUP = !values.DISABLE_SIGNUP
    // The backend uses empty string to represent no required characters in the password
    if (payload.PASSWORD_REQUIRED_CHARACTERS === NO_REQUIRED_CHARACTERS) {
      payload.PASSWORD_REQUIRED_CHARACTERS = ''
    }

    // The backend uses false to represent that email confirmation is required
    payload.MAILER_AUTOCONFIRM = !values.MAILER_AUTOCONFIRM

    updateAuthConfig(
      { projectRef: projectRef!, config: payload },
      {
        onError: (error) => {
          toast.error(`Failed to update settings: ${error?.message}`)
        },
        onSuccess: () => {
          toast.success('Successfully updated settings')
        },
      }
    )
  }

  return (
    <PageSection>
      <PageSectionMeta>
        <PageSectionSummary>
          <PageSectionTitle>User Signups</PageSectionTitle>
        </PageSectionSummary>
      </PageSectionMeta>
      <PageSectionContent>
        {isError && (
          <AlertError
            error={authConfigError}
            subject="Failed to retrieve auth configuration for hooks"
          />
        )}

        {isPermissionsLoaded && !canReadConfig && (
          <div className="mt-8">
            <NoPermission resourceText="view auth configuration settings" />
          </div>
        )}

        {isLoading && (
          <Card>
            <CardContent className="py-6">
              <ShimmeringLoader />
            </CardContent>
            <CardContent className="py-6">
              <ShimmeringLoader />
            </CardContent>
            <CardContent className="py-6">
              <ShimmeringLoader />
            </CardContent>
            <CardContent className="py-7">
              <ShimmeringLoader />
            </CardContent>
            <CardContent className="py-7"></CardContent>
          </Card>
        )}

        {isSuccess && (
          <Form_Shadcn_ {...form}>
            <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-4">
              <Card>
                <CardContent>
                  <FormField_Shadcn_
                    control={form.control}
                    name="DISABLE_SIGNUP"
                    render={({ field }) => (
                      <FormItemLayout
                        layout="flex-row-reverse"
                        label="Allow new users to sign up"
                        description="If this is disabled, new users will not be able to sign up to your application"
                      >
                        <FormControl_Shadcn_>
                          <Switch
                            checked={field.value}
                            onCheckedChange={field.onChange}
                            disabled={!canUpdateConfig}
                          />
                        </FormControl_Shadcn_>
                      </FormItemLayout>
                    )}
                  />
                </CardContent>
                {showManualLinking && (
                  <CardContent>
                    <FormField_Shadcn_
                      control={form.control}
                      name="SECURITY_MANUAL_LINKING_ENABLED"
                      render={({ field }) => (
                        <FormItemLayout
                          layout="flex-row-reverse"
                          label="Allow manual linking"
                          description={
                            <>
                              Enable{' '}
                              <InlineLink
                                className="text-foreground-light hover:text-foreground"
                                href={`${DOCS_URL}/guides/auth/auth-identity-linking#manual-linking-beta`}
                              >
                                manual linking APIs
                              </InlineLink>{' '}
                              for your project
                            </>
                          }
                        >
                          <FormControl_Shadcn_>
                            <Switch
                              checked={field.value}
                              onCheckedChange={field.onChange}
                              disabled={!canUpdateConfig}
                            />
                          </FormControl_Shadcn_>
                        </FormItemLayout>
                      )}
                    />
                  </CardContent>
                )}
                <CardContent>
                  <FormField_Shadcn_
                    control={form.control}
                    name="EXTERNAL_ANONYMOUS_USERS_ENABLED"
                    render={({ field }) => (
                      <FormItemLayout
                        layout="flex-row-reverse"
                        label="Allow anonymous sign-ins"
                        description={
                          <>
                            Enable{' '}
                            <InlineLink
                              className="text-foreground-light hover:text-foreground"
                              href={`${DOCS_URL}/guides/auth/auth-anonymous`}
                            >
                              anonymous sign-ins
                            </InlineLink>{' '}
                            for your project
                          </>
                        }
                      >
                        <FormControl_Shadcn_>
                          <Switch
                            checked={field.value}
                            onCheckedChange={field.onChange}
                            disabled={!canUpdateConfig}
                          />
                        </FormControl_Shadcn_>
                      </FormItemLayout>
                    )}
                  />

                  {form.watch('EXTERNAL_ANONYMOUS_USERS_ENABLED') && (
                    <Alert_Shadcn_
                      className="flex w-full items-center justify-between mt-4"
                      variant="warning"
                    >
                      <WarningIcon />
                      <div>
                        <AlertTitle_Shadcn_>
                          Anonymous users will use the{' '}
                          <code className="text-code-inline">authenticated</code> role when signing
                          in
                        </AlertTitle_Shadcn_>
                        <AlertDescription_Shadcn_ className="flex flex-col gap-y-3">
                          <p>
                            As a result, anonymous users will be subjected to RLS policies that
                            apply to the <code className="text-code-inline">public</code> and{' '}
                            <code className="text-code-inline">authenticated</code> roles. We
                            strongly advise{' '}
                            <Link
                              href={`/project/${projectRef}/auth/policies`}
                              className="text-foreground underline"
                            >
                              reviewing your RLS policies
                            </Link>{' '}
                            to ensure that access to your data is restricted where required.
                          </p>
                          <Button asChild type="default" className="w-min" icon={<ExternalLink />}>
                            <Link href={`${DOCS_URL}/guides/auth/auth-anonymous#access-control`}>
                              View access control docs
                            </Link>
                          </Button>
                        </AlertDescription_Shadcn_>
                      </div>
                    </Alert_Shadcn_>
                  )}

                  {!authConfig?.SECURITY_CAPTCHA_ENABLED &&
                    form.watch('EXTERNAL_ANONYMOUS_USERS_ENABLED') && (
                      <Alert_Shadcn_ className="mt-4">
                        <WarningIcon />
                        <AlertTitle_Shadcn_>
                          We highly recommend{' '}
                          <InlineLink href={`/project/${projectRef}/auth/protection`}>
                            enabling captcha
                          </InlineLink>{' '}
                          for anonymous sign-ins
                        </AlertTitle_Shadcn_>
                        <AlertDescription_Shadcn_>
                          This will prevent potential abuse on sign-ins which may bloat your
                          database and incur costs for monthly active users (MAU)
                        </AlertDescription_Shadcn_>
                      </Alert_Shadcn_>
                    )}
                </CardContent>
                <CardContent>
                  <FormField_Shadcn_
                    control={form.control}
                    name="MAILER_AUTOCONFIRM"
                    render={({ field }) => (
                      <FormItemLayout
                        layout="flex-row-reverse"
                        label="Confirm email"
                        description="Users will need to confirm their email address before signing in for the first time"
                      >
                        <FormControl_Shadcn_>
                          <Switch
                            checked={field.value}
                            onCheckedChange={field.onChange}
                            disabled={!canUpdateConfig}
                          />
                        </FormControl_Shadcn_>
                      </FormItemLayout>
                    )}
                  />
                </CardContent>
                <CardFooter className="justify-end space-x-2">
                  {form.formState.isDirty && (
                    <Button type="default" onClick={() => form.reset()}>
                      Cancel
                    </Button>
                  )}
                  <Button
                    type="primary"
                    htmlType="submit"
                    disabled={!canUpdateConfig || isUpdatingConfig || !form.formState.isDirty}
                    loading={isUpdatingConfig}
                  >
                    Save changes
                  </Button>
                </CardFooter>
              </Card>
            </form>
          </Form_Shadcn_>
        )}
      </PageSectionContent>
    </PageSection>
  )
}